使@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没有选择将它们排除在外。