如何为嵌套对象的方法编写JSDoc注释?

19 浏览
0 Comments

如何为嵌套对象的方法编写JSDoc注释?

我一直在尝试使用JSDoc3来生成一个文件的文档,但是遇到了一些困难。这个文件(一个Require.js模块)基本上看起来像这样:

define([], function() {

/*

* @exports mystuff/foo

*/

var foo = {

/**

* @member

*/

bar: {

/**

* @method

*/

baz: function() { /*...*/ }

}

};

return foo;

}

问题是,我无法让baz在生成的文档中显示出来。相反,我只得到一个名为foo/foo的模块的文档文件,列出了一个bar成员,但是bar没有baz(只有一个指向foo源代码的链接)。

我尝试将bar的指示改为@property,也尝试将baz的指示改为@member或@property,但是这些都没有帮助。无论我做什么,baz似乎都不想出现。

有人知道我可以使用什么指令结构来使baz出现在生成的文档中吗?

附言:我尝试阅读JSDoc网站上像这个页面http://usejsdoc.org/howto-commonjs-modules.html这样的页面,但它只描述了foo.bar的情况,而不是foo.bar.baz的情况。

0