jsdoc将所有下划线方法设为私有

时间:2017-04-10 13:14:06

标签: jsdoc

我有一个使用jsdoc的大型代码库。我们刚刚注意到很多私有方法都没有@private标志。

有没有办法设置配置以查看以下划线开头的所有方法为私有?我真的想避免不必手动操作数百个文件。

2 个答案:

答案 0 :(得分:0)

我找到了答案。 我安装了这个: https://www.npmjs.com/package/jsdoc-autoprivate 遗憾的是缺乏文档。 在我的jsdoc.conf.json中,在源代码下,我不得不将其添加为插件:

"plugins": [
  "node_modules/jsdoc-autoprivate/autoprivate.js"
]

它有效。

答案 1 :(得分:0)

万一其他人发现了这个问题,jsdoc包含一个名为underscore的插件,可以很好地完成此任务:

"plugins": [
  "plugins/underscore.js"
]