本主题解释审查人员如何使用代码审查来审查作者的代码,然后接受它或请求其他更改。

本章包含:

典型的工作流

评审员使用代码评审如下:

  1. 导入或刷新 Quality Tasks 视图中的任务。
  2. 双击要检查的修订或代码检查问题的 To Review 节点,打开要检查的源文件之一。
    • 这将在比较面板中打开所选的文件修订。作者的修改显示在比较面板的左侧。该文件的上一版本显示在右边。代码评审自动比较这两个修订并突出显示最近的更改。右边的指示符指示对所选文件进行了多少更改,允许轻松地从一个更改导航到另一个更改。



    • 请注意,下面的图标表示需要审查的修订:



      下面的图标表示已经输入的代码检查问题:



      源码控制配置说明

      如果以前没有指定源代码控制存储库,则在双击文件节点后将打开配置对话框。在打开 Com-pare 窗格中的代码之前,必须完成此操作。

  3. 检查修改。
  4. 如果还没有这样做,请选择 Parasoft> Show View> Code Review Issue 以打开 Code Review Issue 视图。
  5. 对于你想要添加的每个新问题:
    1. 以下列其中一种方式指定相关代码:

      若要要对此添加评论...这样做...
      特定的一行代码
      1) 右键单击 Compare 面板中的这行代码。
      2) 从快捷菜单选择 Add Code Review Issue
      3) 添加注释。
      代码评审自动将文件路径添加到注释中。
      一个或多个一般问题
      1) 右键单击相关 To Review 任务节点。
      2) 选择 Add General Issue
      3) 添加注释。
      如果任务节点具有相同的会话标记、任务名称或评论、所有者和审阅者,则可以选择多个 To Review 任务节点进行审阅。  也将为相同项目的文件创建的一般问题设置此项目。也将为相同包中的文件创建的一般问题设置此包。该问题将具有与原始选择中设置的相同的会话标记、任务名称和审阅器配置。
      文件组(与任何特定问题无关)
      1) 右键单击适当的代码评审树项。
      2) 选择 Add General Issue
      3) 添加注释。
    2. 选择最能描述你问题的类别。

    3. 指出你所提出问题的严重程度。
    4. 输入你的注释。
  6. 对于要响应的每个现有代码检查问题,请检查更改和在 Add New Comment to Current Issue 框中输入你的注释。
  7. 说明是否需要额外的作者任务来解决当前问题:
    • 如果作者需要对你输入或评论的问题进行更多的修改,请单击 To Fix.




      一旦提交了问题,这个修改请求将分配给作者。 
    • 如果想表明以前输入的问题已经解决,请单击 Accept



      这表明当前问题不需要额外的操作。如果你的团队遵循默认的工作流策略,那么在提交此操作之后,问题将被认为是“关闭的”。否则,它将被发送给作者,然后作者可以关闭修订。




  8. 通过单击 Code Review Issue 视图顶角上的 Commit Review 按钮提交你对这个问题的评论。


    • 如果这是你第一次评审这个修订,那么这个修订将保留在评审树中,直到你将它标记为已接受或已完成(如下面的步骤所述)。这允许你继续检查文件并根据需要输入其他问题。这适用于使用以下图标标记的检查任务:



    • 如果你正在响应一个特定的先前输入的代码评审问题,那么相关的代码评审任务将从评审树中删除,或者将其状态更改为等待。这适用于提交带有以下图标的评审任务:



  9. 当你完成了对该文件的审阅(即,你不希望为其添加任何其他问题,并希望将其从代码评审树中删除),请右键单击该节点,然后选择 Mark as Accepted 或 Mark as Done (可用的命令取决于你的配置 — 有关更多详情,请参见下面内容)。

工作流图

下图说明了各种可用的工作流。

有关更多详情,请查阅 Workflow Overview

拒绝评审(仅在提交前)

如果想要拒绝一个评审(例如,如果想要提交变更的代码恢复到它最初的状态),则在代码评审树中右键单击适当的项目,然后从快捷菜单中选择 Reject 。

添加或更改分配的审阅人员

如果你想添加另一个审阅人员(如,第二意见),请右键单击代码审查树中的适当项,然后从快捷菜单中选择 Add Reviewer 。

如果你想把审阅重新分配给另一个审阅人员,请右键单击代码审查树中的适当项,然后从快捷菜单中选择 Reassign

  • No labels