AMD + Backbone + JSDoc3文件的最佳方式
我正在寻找记录我的代码的最佳方式，但我没有找到任何东西。
我看到了其他主题，包括这些，但是这些都不能解决我的问题。
我有这样的事情：
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;
});
我需要生成一个清晰的文档，其中产品和产品分类模型/产品模块，但我明白了模块和类别。
我想有人经历过这个问题。
谢谢。
PD1：我真的读过其他文章，我不想重复提问。
PD2：对不起，我可怜的英语：S
阅读完本文后，我明白您的问题可以通过将以下代码移动到文件顶部来解决：
/**
* @module models/products
*/
我明白，既然你写了一个匿名函数@module它只是被忽略。