我正在使用John Resig的Class extend来构建一组组件,我正在使用JsDoc为它们创建文档。当我创建这样的“类”时:
/**
* Tests a thing to see what it is, baby
* @param {string=}Id the Id babyyyy
* @constructor
*/
TestThing = function(Id){
/**
* The thing's id
* @type {string=}
*/
this.Id = Id;
}
/**
* Gets the thing
* @param {number} id
* @returns {number}
* @memberof TestThing
*/
TestThing.prototype.Get = function(id){
return 5;
}
JsDoc按预期工作,在文档中创建一个类。
当我使用John的扩展创建一个:
/**
* Tests a thing to see what it is, baby
* @constructor
*/
TestThing2 = Class.extend({
/**
* Creates another thing
* @constructs TestThing2
* @param {number} id
*/
init: function(id) {
/**
* The thing's id
* @type {string=}
*/
this.Id = id;
},
/**
* Gets the thing
* @param {number} id
* @returns {number}
* @memberof TestThing2
*/
Get: function(id) {
return 5
}
})
我在同一页面上获得了该类的2个版本的文档,第一个没有构造函数参数(所以新的TestThing2()),第二个带有参数( new TestThing2 (ID))。
显然我不想要两个版本的文档,特别是当第一个版本“错误”时。我猜我错过了一些标签或东西,但我无法弄清楚是什么。
提前致谢。
答案 0 :(得分:2)
如果删除第二个示例中的第一个doclet,则文档中只会有一个类,链接和文档指向正确的位置。