我正在寻找记录我的代码的最佳方式,但我什么也没找到。
我看过其他主题,包括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;
});
我需要生成一个清晰的文档,其中Product和Products类出现在模型/产品模块中,但我清楚地了解了模块和单独的类。
我想有人经历过这个问题。
谢谢。
PD1:我真的读过其他帖子,我不想重复问题。
PD2:对不起我的英语不好:S