【发布时间】：2015-10-23 03:12:31
【问题描述】：
Sonarqube 可以考虑 Javascript 文件中的 JSdoc 吗？
Sonarqube 分析了许多 javascript 源文件，但“文档”指标仍为 0。
“评论”指标显示正确的值，但文档指标并非如此。
【问题讨论】：
标签： javascript documentation sonarqube jsdoc
【发布时间】：2015-10-23 03:12:31
【问题描述】：
根据thread from 2012，它应该是可用的。但是该链接已失效。
SONARS-46 和SONARJS-182 的声纳问题告诉我们，来自 JavaScript 的 JSDocs 已被 SonarQube 分析，但可能仍有一些问题。
有一个 bunch of bugs 指的是当前正在处理的评论处理，应该与 sonarjs 的 2.8 版一起上线。
【讨论】：
-
这里你说的是检测注释掉代码的规则。但据我了解，问题是关于给出记录代码百分比的指标。
JavaScript 项目确实不支持文档度量，因为 文档是一个百分比，计算如下：
- 记录的公共 API 元素的数量
- 未记录的公共 API 元素的数量
那么问题是什么是公共 API 元素？例如，在 Java 中，它非常简单，例如：对于一个类，每个公共方法都是公共 API，而私有方法不是。
但是在 JavaScript 的情况下，没有严格的方法来确定公共 API 来自什么，什么不是。此信息是必需的，因为我们需要一个比较值，例如：对于已注释的行，我们有未注释的行，并根据这两个值计算注释百分比值。
我希望这是清晰和有用的，如果您对如何在 JavaScript 中识别公共 API 有任何建议，非常欢迎您！
【讨论】：