我试图编写类似于以下内容的文档,其中baz1和bazzed是包含在bar中的属性,bar是Foo的成员
/**
* @class
*/
function Foo(){
this.bar = {
/**
* The baz function
*/
baz1: function(){},
/**
* The baz1 function
*/
bazzed: 'bazzed'
}
}
var foo = new Foo();
//call baz and baz1
foo.bar.baz();
foo.bar.baz1;现在,JSDoc记录了Foo和bar,但是它忽略了baz1和bazzed。
我意识到我可以做这样的事
/**
* @class
*/
function Foo(){
/**
* @property {function} baz - Does baz
* @proprety {string} baz1 - Stores baz1
*/
this.bar = {
/**
* The baz function
*/
baz1: function(){},
/**
* The baz1 function
*/
bazzed: 'bazzed'
}
}但我不愿这样做,原因有三:
baz2:function(){}实现了baz10:function(){}baz有很大的评论块,在bar的评论块中包含似乎是没有意义的。foo.bar.baz.buzz(),它只混合了1和2的原因。我知道这是个很长的问题,但我在过去的4个小时里一直在寻找空的答案。
发布于 2014-03-26 17:24:30
把酒吧列为Foo的子类怎么样?
/**
* @class
*/
function Foo(){
/**
* @class
* @type {{baz1: baz1, bazzed: string}}
*/
this.bar = {
/**
* The baz function
*/
baz1: function(){},
/**
* The baz1 function
*/
bazzed: 'bazzed'
}
}https://stackoverflow.com/questions/22055705
复制相似问题