度量:注释与文档化的API
度量:注释与文档化的API
提问于 2011-06-28 17:07:59
为了评估代码的质量，我被要求运行一些代码度量。其中一个指标被含糊地指定为“注释”。
我在代码上运行Sonar，虽然我在“注释/loc比率度量”上获得了10%，但在"documented“度量(它给出了带有javadoc注释的方法/类/实例变量的数量)上我得到了50%。
我将试图说服经理和客户，“文档化的API”度量比第一个度量代码的质量更相关，特别是度量的目标是评估项目的可维护性，以防另一个团队接受它。
对于这两种度量中哪一种更适合于评估代码的质量和可维护性，您有研究/意见吗？我可以用它们作为说服工具。谢谢
回答 1
Software Engineering用户
回答已采纳
发布于 2011-06-28 17:27:46
没有正式的研究，但对此有一些想法。
- 关于代码和注释的度量很少告诉您任何有用的信息。
- 非常好，简单的代码需要很少的注释。
- 用于第三方消费的公共APIs应该有详细的文档记录，即使这些方法是相当不言自明的。
因此，我想说--确保覆盖了公共API，并对代码进行快速扫描，以查看是否适当地应用了额外的注释(例如，当有一段棘手的代码或需要解释的奇怪业务规则时)。
页面原文内容由Software Engineering提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://softwareengineering.stackexchange.com/questions/87737
复制相关文章
相似问题
腾讯云开发者
