跳到主要内容

Code Analysis

代码分析仪表板是一个用于深入分析代码质量的工具,跟踪可靠性、安全性和可维护性等指标,以提高代码质量并主动防止潜在问题。

代码分析仪表板

从侧边菜单中选择仪表板/Code Analysis

关键功能

Code Analysis Dashboard,可以执行以下操作:

  1. 搜索报告,具体如下:

    • 按项目过滤
    • 按项目和项目配置文件过滤
    • 按项目、配置文件和配置文件应用过滤
    • 按项目和项目组过滤
    • 按项目、配置文件和项目组过滤
  2. 复制当前代码质量仪表板的URL。

  3. 重置仪表板:

点击重置按钮时,所选的项目、配置文件、应用程序和组的数据将被重置。

  1. 配置Sonar:

允许用户导航到Sonar配置屏幕,用户可以查看项目详细信息、配置文件详细信息、应用程序详细信息、创建新配置、手动获取同步、编辑配置和删除配置。

  1. 通过启用或禁用图表/表格来自定义显示的报告

  1. 在数据视图和图表视图之间切换。

  2. 在仪表板上展开特定报告图表。

  3. 在PR(拉取请求)和非PR(非拉取请求)模式之间切换: With mode PR: 看板展示了来自拉取请求的提交数据,这些是拉取请求工作流的一部分,通常用于在合并到主分支之前进行代码审查。

With non PR: 看板展示了没有拉取请求的提交数据,这些是直接提交(例如,直接推送到主分支或其他分支)而不与任何拉取请求相关联的提交。

默认情况下,仪表板以拉取请求模式显示。

关键组件

该仪表板提供评估代码质量所需的关键指标,使开发人员能够评估和提高代码库的可靠性、安全性和可维护性。关键组件包括:

Line of Code (LOC): 可视化代码库中总行数的趋势,帮助监控代码增长。

LOC的增加反映了新功能或修改的添加,有助于理解项目范围或复杂性的变化。

  • Y轴(代码行数):表示项目中的代码总行数。
  • X轴(时间):显示时间线,指示测量代码行数的日期。

Code Churn: 显示随时间增加或删除的代码行数,指示代码更改的频率,以评估代码的稳定性和修改频率。

高变更率可能表明活跃的功能更新或重构时期。监控此图表有助于维护代码的稳定性。

  • Y轴(更改):表示代码更改的数量,包括添加、删除和修改。
  • X轴(日期):显示代码更改发生的日期。

Reliability: 显示在代码库中检测到的错误数量,以评估代码的可靠性。

该指标评估代码的可靠性,错误数量越高,稳定性越低。它有助于识别需要质量改进的领域。 表示已识别的错误总数。错误数量的下降趋势表明代码质量在改善。

Test Coverage: 表示被测试覆盖的代码百分比。

测试覆盖率对于评估代码稳定性至关重要。更高的覆盖率意味着更多的代码经过测试,从而减少意外错误的可能性。

Duplicated Blocks: 显示代码库中重复代码块的数量。

减少代码重复可以提高可读性和可维护性。

Security: 显示潜在安全漏洞的数量,以评估代码安全性。

该指标评估安全风险,漏洞较少表明安全性增强。更高的漏洞数量意味着数据泄露或系统被攻破的风险更大。

Security Hotspots:显示代码中需要进行安全审查的区域数量。

帮助识别代码中可能存在的脆弱区域,以便进行审查和缓解,从而增强安全性。

Maintainability - Debt:指示未来维护代码库所需的估计时间(以天为单位)。

技术债务反映了长期维护负担,数值越高表示需要改进的区域越多。

Maintainability - Code Smells: 显示代码异味的总数,这会妨碍代码的可维护性。

减少代码异味可以提高代码质量并简化维护。

Duplicated Lines: 显示重复行的百分比,识别可能需要重构的区域。

较低的重复百分比简化了维护并提高了代码效率。

Top Contributor of Week:显示本周基于代码提交的顶级贡献者。

较低的重复百分比简化了维护并提高了代码效率。

Top Reviewer:按活动顺序列出最活跃的审阅者。 代码审查对于维护和提高代码质量至关重要;突出频繁的审查者可以鼓励对质量控制的贡献。

Top Contributor Over Time: 显示了随时间变化的顶级贡献者,帮助跟踪贡献趋势的变化。

跟踪长期贡献以识别持续参与并鼓励表现。