有没有办法将@property 设为私有?
/**
*
* @property {Object} shouldBePrivate but how?
*
*/
...
我正在使用jsdoc3
我希望能够生成我的文档两次,一次列出私有属性,另一次没有列出私有属性。
有没有办法将@property 设为私有?
/**
*
* @property {Object} shouldBePrivate but how?
*
*/
...
我正在使用jsdoc3
我希望能够生成我的文档两次,一次列出私有属性,另一次没有列出私有属性。
使用@private
JSDoc 中的标记。HTML 生成器可以选择包含或不包含私有成员,因此您可以一次生成文档,一次不生成文档。
像这样:
/**
* Lore Ipsum and stuff
* @property {foo}
* @private
*/
只需添加标签@private
/**
*
* @property {Object} shouldBePrivate but how?
* @private
*/
@private 标记将符号标记为私有,或不用于一般用途。私有成员不会显示在生成的输出中,除非 JSDoc 使用 -p 或 --private 开关运行。
所以,只要运行
jsdoc --private file.js
或者
jsdoc -p file.js
在 file.js 和 jsdoc 的文档中包含私有符号,而没有排除它们的选项。