更新时间:2024-10-10 GMT+08:00

查看代码检查结果

前提条件

您已创建执行代码检查任务

查看代码检查详情

  1. 基于项目入口访问CodeArts Check服务首页
  2. 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态。

    • 新问题:表示本次代码检查任务执行后新增的问题。
    • 未解决:表示该代码检查任务未解决的问题。
    • 已解决:表示该代码检查任务已解决的问题。

  3. 单击检查任务名称,进入代码检查详情概览页,可查看的信息如下:

    • 原始代码行数。
    • 门禁结果:检查结果分为“通过”“不通过”,同时会展示“致命问题数”“严重问题数”

      代码检查是否通过是由设置的质量门禁值判断,门禁值设置请参考配置代码检查任务质量门禁

    • 问题数:检查出来的代码质量问题数。
    • 延迟上线问题数:由于检查引擎的能力提升,出现的新问题数。
    • 未解决新问题数:当前的代码检查结果中,未解决的问题个数。
    • 已解决问题数:当前的代码检查结果中,已解决的问题个数
    • 代码平均圈复杂度:代码的平均圈复杂度
    • 代码重复率:代码的重复率
    • NBNC代码行:非空非注释的代码行数。
    • 问题数最多Top10检查规则:问题数Top10的检查规则以及每条规则对应的问题数。
    • 待处理问题严重程度:待处理的各个等级问题数量分布情况。
    • 问题指派分配:检查出来的代码问题修改分配情况。如果已指派的数量与问题数不一致,说明存在某代码问题还未分配修改责任人。
    • 历史趋势:默认展示近一个月内该代码检查任务的检查结果变化趋势,包括问题数、圈复杂度和重复率。

查看代码问题

可查看代码问题详情有两种查看方式:导出至本地和在线查看。

  • 导出至本地
    方式一:
    1. 返回至代码检查任务列表页,勾选代码检查任务名称前的复选框,可选择的任务数为1~20。
    2. 选择更多操作 > 导出任务告警
    3. 在弹出的窗口中选择需要导出的选项,单击“开始导出”
    4. 单击“查看下载”,即可查看导出进度。
    5. 待导出完成后,单击“下载”,可将代码检查问题信息导出至本地。

    方式二:

    1. 单击“代码问题”页签。
    2. 选择全量操作 > 全量导出,可将代码检查问题信息导出至本地。
  • 在线查看
    1. 单击“代码问题”页签,可以在“过滤器”区域,根据过滤条件筛选问题作,可设置的过滤条件如下表。

      过滤条件

      说明

      问题级别

      分为致命、严重、一般、提示四个级别。

      问题状态

      包括待处理、已解决、已忽略、已修复四种状态。

      延迟问题

      查看当前检查出的问题中正式版本问题总数和延迟上线版本问题总数。

      检测时间

      根据检测时间区分新问题和存量问题。

      说明:

      设置新问题起始时间,问题发现时间在起始时间之后的则为新问题。

      文件名

      按照源文件名称筛选代码问题。

      语言

      按照检查的语言筛选代码问题。

      规则

      按照问题命中的规则筛选代码问题,便于用户一次性解决同一类问题。

      标签

      按照规则的用户标签筛选代码问题。

      负责人

      按照问题分配负责人筛选代码问题。

      说明:

      代码检查过程中,开启精准匹配自动将新问题分配给问题代码行的最后一次提交者。

      CWE

      按照安全类规则名筛选代码问题。

    2. 设置完筛选条件后,在右侧区域对检查问题可进行以下操作。
      • 如果该问题已解决,单击“待处理”选择“已解决”;如果该问题无需处理,单击“待处理”选择“忽略问题”,忽略问题时需提交评论。
      • 单击“负责人”,可将此问题提交至其他负责人。
      • 单击“问题帮助”,可查看该问题对应的规则详情。
      • 单击“查看上下文”,在问题详情页面中,可修改问题状态、转移责任人和根据“问题帮助”单击前往代码仓对代码进行修改。
      • 单击“创建问题单”,提交问题单给指定的责任人。该功能仅Scrum类型项目支持。
      • 单击“生成报告”,可将代码问题生成PDF格式的文件报告。
      • 单击全量操作 > 全量修改问题状态,可修改筛选出来的全部问题的问题状态。

        如果代码问题数是0,则不显示该内容。

      • 单击全量操作 > 全量转移责任人,可将筛选出来的全部问题转移给指定责任人。

查看代码度量

代码度量可准确的反映提交代码的质量,助力用户及时发现并修改问题,提升研发效能。代码度量包括已下两种类型的问题:

  • 圈复杂度:代码的复杂度。

    扫描Shell语言代码时,度量结果不支持圈复杂度计算。

    单击文件名称进入文件详情页面,单击可进入到对应的代码仓修改代码。

  • 重复率:代码检查服务通过重复块、重复行、重复率来识别被测代码的重复情况。

    修改重复率问题操作指导如下:

    1. 单击文件名称进入文件详情页面。
    2. 文件详情页面左侧的竖线标识了重复的代码块,单击标识竖线,将会显示与该段代码重复的文件列表。

    3. 单击文件名称,可对比查看两个文件的重复代码块。

    4. 单击可进入到对应的代码仓修改代码。

查看检查日志

单击“检查日志”页签,可查看检查步骤日志和检查参数。

图1 步骤日志
图2 检查参数