javascript - example - AMD+Backbone+JSDoc3 la mejor manera de documentar

jsdoc example

Question

Estoy buscando la mejor manera de documentar mi código, pero no encuentro nada.

He visto otros temas, incluido esto , pero no todos resuelven mi problema.

Tengo algo como esto:

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;
});

Necesito generar una documentación legible, donde las clases de productos y productos aparecen en el módulo de modelos / productos , pero obtengo el módulo claro y las clases por separado.

Supongo que hay alguien que ha pasado por este problema.

Gracias.

PD1: Realmente leí otras publicaciones, no estoy tratando de duplicar preguntas.

PD2: lo siento mi pobre inglés: S

Answer 1

Después de leer este documento , entiendo que su problema se puede resolver moviendo el siguiente código a la parte superior del archivo:

/**
* @module models/products
*/

Entiendo que ya que ha escrito @module dentro de una función anónima, simplemente se ignorará.