代码检视操作实践

“检视意见设置”与“检视意见模板设置”仅支持“专业版套餐及以上”用户。

背景信息

代码检视是指开发人员在完成代码设计、编写、调试后指派给其它人员对代码展开阅读、审视的过程。代码检视的目的是发现代码中的格式、逻辑、语法等规范性和正确性问题，从而保证代码的质量。由于在代码检视阶段发现代码问题的成本是最低的，因此严格认真的执行代码检视对于提升代码质量是十分必要的。为了能使您更高效、快捷地进行代码检视，您可根据自己的实际需求在代码托管服务添加检视意见设置模板。

操作前提

已有可用项目，如果没有，请先新建项目。
- 如果您购买CodeArts整体服务的套餐，则需要在需求管理服务中进行新建项目。
- 如果您购买CodeArts Repo单服务的套餐，则需要在新建仓库的同时进行新建项目，此时创建的项目为Scrum项目或IPD项目。
已有可用仓库，如果没有，请先新建仓库。

操作流程

在开始代码检视之前，需要管理员先做如下管理设置，再进行代码检视，具体流程如下：

图1 代码检视操作过程

本文详细描述了检视意见设置、检视评论模板设置、检视意见通知设置、新建评审意见和解决评审意见整个操作的完整过程。大致分为以下步骤，您可根据熟悉程度选择阅读：

检视意见设置
检视意见模板设置
检视意见通知设置
新建评审意见
解决评审意见

检视意见设置

检视意见设置用于规范检视意见及配置检视意见模板设置，此设置只针对被设置的仓库生效，只有仓库管理员和仓库所有者能看到这个页面且有设置权限。

进入软件开发生产线首页，单击目标项目名称，进入项目。
单击菜单“代码 > 代码托管”，进入代码托管服务。
进入仓库详情，单击“设置 > 策略设置 > 检视意见”，进入检视意见设置页面。
根据需要选择是否勾选“启用检视意见分类与模块”启用检视意见。
配置检视意见分类。
- 启用系统预置检视意见分类
   勾选“启用系统预置检视意见分类”，可直接使用系统预置检视意见分类。
- 自定义分类
   支持自定义检视意见分类，输入“类型名称”如代码规范问题，按Enter键保存。
  
  名称最多200个字符，最多支持新建20个。
在“检视意见模块设置”下输入框输入“类型名称”。

名称最多200个字符，最多支持新建20个。
根据您的需要勾选“启用新建/编辑检视意见时必填字段校验”。
单击“提交”，保存设置。

检视意见模板设置

检视评论模板位于仓库详情中的“设置 > 模板管理 > 检视意见模板”。您可新建、编辑和删除检视意见模板，并根据自身习惯定制检视意见模板信息，包括：严重程度、指派给、意见分类、意见模板和描述。当仓库成员进行检视评论时，您可选择一个检视意见模板，模板内容将会自动应用到合并请求或待检视代码文件上。此设置只针对被设置的仓库生效。只有仓库管理员和仓库所有者能看到这个页面且有设置权限。

您可根据表1新建检视意见模板。

表1 字段说明
字段	说明
模板名称	必填项，新建模板的名称。如代码检视意见模板。
设置为默认模板	非必填项，勾选后，进行检视评论时默认应用此模板。
严重程度	非必填项，根据问题的严重程度可分为“致命”、“严重”、“一般”、“建议”四种类型。如“严重程度”为“一般”。
指派给	非必填项。指派给为“空”。 MR中添加检视意见时，默认指派给MR创建者。文件或Commit中添加检视意见时，默认不指派。指派给为“MR创建者/Commit作者”。 MR中添加检视意见时，默认指派给MR创建者。文件或Commit中添加检视意见时，默认指派给Commit作者。指派给为“具体人员”。 MR中添加检视意见时，默认指派给具体人员。文件或Commit中添加检视意见时，默认指派给具体人员。如指派给为“MR创建者”。
意见分类	非必填项，默认禁用，需“启用检视意见分类与模块”并配置检视意见分类才可设置，详情请参见检视意见。
意见模块	非必填项，默认禁用，需“启用检视意见分类与模块”后配置检视意见模块才可设置，详情请参考检视意见。
描述	非必填项，填写模板的描述信息，支持描述信息预览。如代码格式问题。

检视意见通知设置

通知设置位于仓库详情的“设置 > 基本设置 > 通知设置”。

图2 通知设置页面

新建评审意见：可手动设置给MR创建人发送邮件通知。
解决评审意见：可手动设置给MR创建人发送邮件通知。

新建评审意见

您可以在“代码”页签的“文件”和“提交”子菜单下，也可以在“合并请求”中“文件变更”子菜单下给待检视文件添加检视意见。

您可以在“合并请求”详情页“评审意见”下给待检视的合并请求添加评论，也可以在“代码”页签下的“提交”子菜单下给提交文件添加评论。

其中在“代码”页签的“文件”和“提交”子菜单下添加的检视意见和评论可以在“评审记录”页签下“源自Commit的评审记录”中查看。

在“合并请求”中“文件变更”子菜单下给待检视文件添加检视意见和在“合并请求”详情页“评审意见”中添加的评论可以在“评审记录”页签下“源自合并请求的评审记录”中查看。

在“代码”页签下“文件”子菜单，新建检视意见。
进入“文件”子菜单，单击“待评审文件”，单击代码行图标，在“文本框”输入评审意见，选择“严重程度”和“指派给”，如“严重程度”为“一般”，“指派给”为“MR创建者”，在下拉框选择“意见分类”和“意见模块”，单击“确定”完成检视意见添加。

图3 新建检视意见
在“代码”页签下“提交”子菜单，新建检视意见。
进入“提交”子菜单，单击“提交记录”下“待检视的文件”，单击代码行图标，在“文本框”输入评审意见，选择“严重程度”和“指派给”，如“严重程度”为“一般”，“指派给”为“MR创建者”，在下拉框选择“意见分类”和“意见模块”，单击“确定”完成检视意见添加。

图4 新建检视意见
在“合并请求”页签中“文件变更”子菜单下，新建检视意见。
进入“文件变更”子菜单，单击代码行图标，在“文本框”输入评审意见，选择“严重程度”和“指派给”，如“严重程度”为“一般”，“指派给”为“MR创建者”，在下拉框选择“意见分类”和“意见模块”，单击“确定”完成检视意见添加。
图5 新建检视意见
在“合并请求”页签中合并请求详情页，新建评论。
进入“合并请求”页签，单击“待检视的合并请求”，进入合并请求详情页。单击“评审记录”，在评审记录下输入评审意见，单击“确定”完成评论的添加。
在“提交”页面中，单击某个提交，切换“评论”界面，即可新建评论。
图6 新建评论