Javascript AMD&x2B;主干+;JSDoc3记录文档的最佳方式
我正在寻找最好的方法来记录我的代码,但我没有找到任何东西 我看过其他的话题,包括,但这些都不能解决我的问题 我有这样的想法:Javascript AMD&x2B;主干+;JSDoc3记录文档的最佳方式,javascript,backbone.js,amd,jsdoc3,Javascript,Backbone.js,Amd,Jsdoc3,我正在寻找最好的方法来记录我的代码,但我没有找到任何东西 我看过其他的话题,包括,但这些都不能解决我的问题 我有这样的想法: define([ 'backbone' ], function (Backbone) { /** * @module models/products */ /** * Product model * @class */ var Product = Backbone.Model.exten
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
,因此它会被忽略。这种要求推荐工具和方法的方式在本网站上被认为是离题的。看:“我们觉得最好的堆栈溢出问题都有一些源代码,但如果你的问题通常涉及程序员常用的……[…]软件工具,那么“你认为它不符合toppic吗?”?我要求正确使用“程序员常用”工具。我不要求更好的使用,我要求的是正确的使用。有人能证实这是否是问题所在吗。我想主要作者不在了。不,如果我把“模块”移到文件的顶部,我的模块没有类,我尝试了它(如果你检查了我在描述中共享的线程),在工厂中使用“借出”,但没有结果。