鲲鹏社区首页
中文
注册
我要评分
文档获取效率
文档正确性
内容完整性
文档易理解
在线提单
论坛求助

编码规范检查

鲲鹏同辕开发流水线使用SonarQube进行编码规范检查。SonarQube是一个管理代码质量的开放平台,涵盖了架构设计、注释、编码规范、潜在缺陷、代码复杂度、重复代码等多个维度的质量分析。帮助检查代码缺陷、改善代码质量以及提高开发速度,可以支持Java、C、C++、JavaScript等多种编程语言的代码质量管理与检测。

包含七个代码质量检查维度:

  • 复杂度分布(complexity):较高的代码复杂度通常会增加代码的风险和错误概率,SonarQube使用复杂度度量工具(如Cyclomatic Complexity)来计算代码的复杂度。
  • 重复代码(duplications):程序中包含大量复制、粘贴的代码而导致代码臃肿,SonarQube可以展示源码中重复严重的地方。
  • 单元测试统计(unit tests):统计并展示单元测试覆盖率,开发或测试可以清楚测试代码的覆盖情况。
  • 代码规则检查(coding rules):通过Findbugs、PMD、CheckStyle等检查代码是否符合规范。
  • 注释率(comments):若代码注释过少,当有人员变动后,其他人比较难以接手;若代码注释过多,又不利于阅读。
  • 潜在的Bug(potential bugs):通过Findbugs、PMD、CheckStyle等检测潜在的Bug。
  • 结构与设计(architecture & design):找出循环,展示包与包、类与类之间的依赖、检查程序之间耦合度。
    图1 代码缺陷检查