Sonarqube可以从Javascript文件中考虑JSdoc吗?
我们有许多由Sonarqube分析的javascript源文件,但“文档”指标仍为0.
“评论”指标显示正确的值,但文档指标并非如此。
答案 0 :(得分:0)
根据thread from 2012,它应该可用。但是这个链接已经死了。
声纳问题SONARS-46和SONARJS-182告诉我们,来自JavaScript的JSDocs由SonarQube进行分析,但可能仍然有点儿错误。
有一个bunch of bugs指的是当前正在处理的评论处理,应该使用sonarjs的2.8。
答案 1 :(得分:0)
确实,JavaScript项目不支持文档度量标准,因为 文档是一个百分比,由以下公式计算:
所以问题是Public API元素是什么?例如,在Java中,它非常简单,例如:对于一个类,每个公共方法都是Public API而私有方法不是。
但是在JavaScript的情况下,没有严格的方法来确定什么是公共API,什么不是。这些信息是必需的,因为我们需要一个比较值,例如:对于注释行,我们有未注释的行,从这两个值我们计算注释百分比值。
我希望这是明确且有用的,如果您对如何在JavaScript中识别公共API有任何建议,我们非常欢迎您!