将@property设为私有

Question

有没有办法让@property私有化？

/**
 *
 * @property {Object} shouldBePrivate but how?
 * 
 */
...

我正在使用jsdoc3

我希望能够两次生成我的文档，一个列出私有属性，另一个没有列出私有属性。

Answer 1

使用JSDoc中的@private标记。 HTML生成器可以选择包含或不包含私有成员，因此您可以使用和不使用一次生成文档。

像这样：

/**
 * Lore Ipsum and stuff
 * @property {foo}
 * @private
 */

Answer 2

只需添加标签@private

即可

/**
 *
 * @property {Object} shouldBePrivate but how?
 * @private
 */

来自Jsdoc3 documentation

  

@private标记将符号标记为私有，或者不是一般的符号   使用。除非，否则私有成员不会显示在生成的输出中   JSDoc使用-p或--private开关运行。

所以，只需运行

jsdoc --private file.js

或

jsdoc -p file.js

在file.js的文档中包含私有符号，而没有用于排除它们的选项的jsdoc。