【问题标题】:jsDoc - Don't exclude methods that are marked as @privatejsDoc - 不要排除标记为 @private 的方法
【发布时间】:2021-03-03 01:36:47
【问题描述】:

目前 jsDoc 不包括我标记为 @private 的类方法,这反过来又不会为这些方法生成文档。我们的文档只在内部使用,所以我仍然希望显示方法,以便其他开发人员知道。

我是否可以在jsdoc.json 文件中添加属性以仍然显示方法、属性等...无论是否标记为@private?

【问题讨论】:

  • 您是否使用--access "all" 运行过?默认是排除私有符号:jsdoc.app/about-commandline.html
  • 不,我没有,我想知道是否可以将它添加到 jsdoc 配置文件中。这确实解决了我的需求,所以我会支持你的回复。

标签: javascript jsdoc


【解决方案1】:

默认情况下,JSDoc 不包括私有符号(那些带有 @private 注释的符号),您可以通过命令行包含它们:

jsdoc --access "all" …

或者通过配置文件:

{
  "access": "all"
}

【讨论】:

  • 太棒了!对于那些将其添加到他们的配置文件的人,它确实位于“opts”对象下。
  • @leroyjenkinss24 哎呀。请随时编辑此答案。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2018-03-08
  • 2015-02-05
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2015-04-15
  • 2021-02-08
相关资源
最近更新 更多