文档首页> 代码检查 CodeArts Check> 最佳实践> 基于CodeArts Repo源码源的代码检查实践
更新时间:2023-08-24 GMT+08:00
分享

基于CodeArts Repo源码源的代码检查实践

通过检查代码漏洞和不规范书写,优化代码质量,规范开发人员编码习惯,帮助企业有效管控代码质量,助力企业成功。

本实践基于CodeArts Repo源码源,介绍如何创建、执行、查看Repo代码检查任务以及根据需要进行规则集设置和任务设置。

一个基本的常用实践流程如下:

准备工作

  • 准备项目,请参见新建项目(以Scrum项目为例)。
  • 在项目下新建代码仓库(以按模板创建,不勾选“自动创建代码检查任务”为例)。

步骤一:新建Repo代码检查任务

完成准备工作后,可以开始新建任务。

  1. 登录软件开发生产线
  2. 搜索准备工作中已创建的项目,单击项目名称,进入项目详情页面。
  3. 单击导航“代码 > 代码检查”,进入项目下代码检查任务列表页面。
  4. 单击“新建任务”,进入“新建任务”页面。

    源码源默认为Repo类型,选择准备工作中已创建的代码仓。

  5. 单击“新建任务”,完成检查任务的创建。

步骤二:新建自定义规则集(可选)

创建好代码检查任务后,可以根据需要给任务新建自定义规则集。

  1. 单击项目内“代码 > 代码检查”,进入代码检查页面。
  2. 单击“规则集”页签,默认进入规则集列表页面。
  3. 单击“新建规则集”,在弹出的“新建规则集”窗口设置规则集名称、检查语言。
  4. 完成后,单击“确定”。
  5. 根据需要勾选规则名称、设置问题级别,单击右上角“保存”,完成自定义规则集创建。

步骤三:设置任务规则集(可选)

在执行任务前,根据需要更换为自定义规则集。

  1. 单击项目内“代码 > 代码检查”,进入代码检查页面。
  2. 在代码检查页面任务列表中,单击步骤一创建的任务名称,进入“代码检查详情”页面。
  3. 选择“设置 > 规则集”。
  4. 在“已包含语言”区域,打开目标语言开关,并在“启用规则集”区域单击需更换的步骤二创建的自定义规则集。
  5. 在弹框中,单击“确定”即可更换语言规则集。

步骤四:执行Repo代码检查任务

设置好规则集后,即按照自定义规则集执行检查。

  1. 单击项目内“代码 > 代码检查”,进入代码检查页面。
  2. 在代码检查页面任务列表中,单击代码检查任务所在行“最近一次检查”中的“立即执行”。

    如果代码检查任务需要再次执行,则单击任务所在行重新执行任务。

  3. 根据页面提示等待任务执行完成。检查结果请参见步骤五:查看Repo代码检查详情

步骤五:查看Repo代码检查详情

执行完代码检查任务后,可以查看代码检查详情。

  1. 单击项目内“代码 > 代码检查”,进入代码检查页面。
  2. 在代码检查页面任务列表中,搜索步骤一创建的任务。
  3. 单击任务名称,查看代码检查详情,包括概览、代码问题、代码度量、检查日志等。

    至此,我们完成了一次基本的CodeArts Repo源码源常用检查流程。

分享:

    相关文档

    相关产品