CodeReview.em代码审核 使用说明.docVIP

代码走读方法CODEREVIEW

【作者】：陈刚chengange

【主题】：代码走读方法

【时间】：2004-0

【正文】：

CodeReview工具的作用

减少大家缺陷记录和汇总时间，方便责任人查找问题出处；

检视完成后生成类似PC-LINT检查的报告，点击按钮可以直接找到错误处；

任务责任人修改完成后，直接修改问题状态，组织者按快捷键即可统计出缺陷数；方便度量数据收集。

CodeReview使用说明

首先将CodeReview.em脚本文件复制到SourceInsight3.0目录下。

建立工程将CodeReivew.em文件加入到base.pr工程下（此工程文件为PC-LINT安装后即生成的工程）。此步骤一定要做，否则无法编辑“Review_Add_Comment”、“Review_Restore_Link”和“Review_Summary”等相关宏。

增加宏快捷键的方法：“SourceInsight”-“Option”-“MenuAnsignment”，在“Command”下查找到特定的宏“Macro:Review_Add_Comment”、“Macro:Review_Restore_Link”，选择“Menu”里特定的位置（建议选择“Edit”菜单），点击菜单边的“Insert”键将宏插入主菜单；对于每个宏，分别点击菜单边的“Key”键，点击“Assignnewkey”后输入快捷键（建议分别使用Ctrl+Alt+A、Ctrl+Alt+R和Ctrl+Alt+S），点击OK。操作完成后可以在“SourceInsight”-“Edit”菜单中看到你设置的宏及其对应快捷键。

下面就可以进行代码检视了：

和以前一样，建立相关工程文件；

在代码检视过程中，在发现缺陷的代码处按“Review_Add_Comment”快捷键（增加注释），会出现一个对话框，在对话框中填写缺陷严重性等级（H/M/L/D，分别是“致命/严重/一般/提示”），回车；然后会出现另一对话框，在该对话框中写明问题原因（简单的注释说明），回车；该问题已经记录完成。

重复以上步骤，直至检视完成；

关闭检视代码工程时，会弹出对话框要求保存检视记录到文件中，缺省文件名为ReviewComment.txt（建议使用检视者姓名拼音作为文件名）。

在检视完成后，将ReviewComment.txt文件提交给代码作者。

代码作者将此文件复制到自己工程根目录下的子目录里，把它添加到代码所在工程里打开，使用“Review_Restore_Link”快捷键恢复链接，然后对相应缺陷进行缺陷确认和代码修改，并直接在ReviewComment.txt文件里填写“resolve”、“categories”和“Author”栏。“resolve”里简要填写解决方法或是拒绝理由。“categories”是缺陷引入阶段（SRS/HLD/LLD/Code等）。“Author”栏填写代码作者姓名（也可以是汉语拼音缩写或者工号，必须是审核人可以辨识的形式）

代码修改完成后，将ReviewComment.txt文件提交给代码检视活动的审核人确认。

审核人将此文件复制到工程根目录下的子目录里，把它添加到代码所在工程里打开，使用“Review_Restore_Link”快捷键恢复链接，按照代码作者在“resolve”栏中的说明进行逐项确认，然后修改相应问题的“status”信息为相应的“close”或“reject”。如果对修改结果有疑问，可以按照“Author”栏信息与代码作者沟通。审核确认完成后使用“Review_Summary”快捷键，生成汇总信息。

注意事项

1. 检视完成后，会自动生成缺省文件名为ReviewComment.txt文件。文件内容如下所示：

FileName:init\main.c

Line:1465

Location:init\main.c/L1465

Reviewer:John

Symbol:do_basic_setup

Categories:Code代码

Class:Defect缺陷

Severity:General一般

DefectType:Function功能

Status:Open //需要审核人填写

Comments:aaaaaaaaaaaaaaaaaa

Resolve://需要代码作者填写

Author://需要代码作者填写

其中，代码作者和审核人填写检视记录时，是直接在该文件文本中进行的。

需要特别注意：填写时一定要保留冒号后面的一个空格；否则自动统计无法进行。

进行缺陷统计时，不能自动统计多个ReviewComment.txt文件。因为检视记录文件是格