Я ищу лучший способ документировать свой код, но я ничего не нахожу.AMD + Backbone + JSDoc3 лучший способ документировать
У меня есть другие темы, в том числе this, но там все не разрешает мою проблему.
У меня есть что-то вроде этого:
define([
'backbone'
], function (Backbone) {
/**
* @module models/products
*/
/**
* Product model
* @class
*/
var Product = Backbone.Model.extend({
/** @lends Product.prototype */
/**
* Some method
* @param {String} name - Name of something
* @return {something}
*/
someMethod: function() {
// ...
}
});
/**
* Products collection
* @class
*/
var Products = Backbone.Collection.extend({
/** @lends Products.prototype */
/**
* @type {Product}
*/
model: Product,
/**
* Some method
* @param {String} name - Name of something
* @return {something}
*/
someMethod: function() {
// ...
}
});
return Products;
});
Мне нужно, чтобы создать разборчивую документацию, где Продукта и Продуктов Классов apears в модели/продукты модулем, но я получаю модуль ясного и классы по отдельности.
Я полагаю, есть кто-то, кто прошел через эту проблему.
Спасибо.
PD1: Я действительно читал другие сообщения, я не пытаюсь дублировать вопросы.
PD2: К сожалению, мой бедный английский: S
Этот способ запроса рекомендаций и способов рассматривается на этом сайте не по теме. Посмотрите: http://stackoverflow.com/help/on-topic – mico
«Мы чувствуем, что у лучших вопросов переполнения стека есть немного исходного кода в них, но если ваш вопрос обычно охватывает ... [...] программные средства, обычно используемые программистами, и это «, ты думаешь, что это не так? Я прошу правильного использования инструмента «обычно используется программистами». Я не прошу лучшего использования, я прошу о правильном использовании. – Exos