使@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沒有選擇將它們排除在外。