PhpStorm 2021.3 Help

审核代码

Space 插件允许您邀请您的同事直接在 PhpStorm 中查看代码并讨论更改。使用 Space 插件,您可以:

  • 如果您希望您的同事审查特定提交,请创建代码审查。

  • 如果您希望您的同事查看两个分支的比较,请创建合并请求。

  • 如果您被邀请参加代码审查,请审查代码,或加入现有审查

创建代码审查

代码审查可让您的团队成员审查在选定提交范围内所做的更改。

  1. 视图中 | 工具窗口 | 在Git工具窗口中,选择Log选项卡。

  2. 右键单击提交并选择Space | 创建代码审查。要缩小提交列表的范围,您可以使用搜索字段和过滤器。

  3. 在打开的代码审查工具窗口中,为您的代码审查输入一个有意义的标题并分配审查者。

  4. 单击创建代码审查

    创建空间代码审查

创建合并请求

合并请求是一种特殊类型的代码审查,它可以让您比较两个分支并邀请您的同事审查它。

  1. 从主菜单中,选择工具 | 空间 | 代码审查

  2. 在打开的Code Review工具窗口中,单击添加按钮并选择Create Merge Request

  3. 选择源分支和目标分支。默认选择当前签出的分支作为源分支,配置的主分支作为目标。

  4. 输入有意义的标题并指定审阅者。

  5. 单击创建合并请求

    创建空间合并请求

审查工具

在 PhpStorm 中,您可以使用Code Review工具窗口浏览可用的评论,使用Timeline 窗格查看评论的历史记录,并使用Diff 窗格预览更改和发布行评论。

代码审查工具窗口

如果您的代码托管在 Space 上代码审查工具窗口会自动打开。它也可以通过工具 | 空间菜单或单击工具栏右侧的个人资料图片。

代码审查显示您的 Space 项目的所有代码审查。代码审查中可用的代码审查列表取决于当前在 PhpStorm 中打开的存储库。选择代码审查会打开其主页,其中包含以下选项卡:

  • 详细信息:显示作者和审稿人。对于代码审查,这也显示了正在审查的分支;对于合并请求,它显示源分支和目标分支。

  • 文件:要审查的文件列表。如果文件包含行注释,它们的计数也会显示在此处。您可以选择一个文件来打开差异窗格

  • 提交:选择一个提交以缩小显示更改的范围。或者右键单击提交并选择在 Git 日志中显示以查看 Git 日志中的提交详细信息和历史记录

细节

时间线窗格

当您打开代码审查或合并请求时,时间轴窗格会出现在编辑器中。它列出了与评论相关的所有评论和事件。您可以在此处发表一般性评论

时间线

差异窗格

选择文件时,编辑器中会出现差异窗格。它是一个普通的 PhpStorm差异查看器,它显示文件的先前版本和当前版本之间的比较。使用 Space 插件,您可以使用它来发布行评论。

审核代码

在 Space 中,典型的代码审查过程涉及两个角色:作者和审查者。两个参与者都可以查看代码、发表评论和回复。在查看代码时,您可以发布两种类型的评论:

  • 时间轴窗格上:一般评论(或审阅评论),未附加到任何文件或部分代码

  • Diff窗格上:行注释,用于讨论特定的代码行

PhpStorm 和 Space 网页版中的所有评论都会立即同步,因此您可以随时随地继续讨论。要格式化文本,您可以使用 Markdown 语法。

查找代码审查

  1. 代码审查工具窗口中,从快速过滤器列表中选择一个过滤器:

    • Open:您的项目中的所有打开的评论。

    • 需要我的审查:在您担任审查员的地方公开代码审查,轮到您了。

    • 需要我注意:在你是作者的地方打开代码审查,轮到你了。

    • 包括我的更改:您作为作者的所有开放代码审查。

    • 分配给我:您作为审阅者参与的公开和封闭审阅。

    • 已关闭:您项目中的所有已关闭评论。

  2. 单击代码审查以打开其详细信息、查看提交和发表评论。

发表一般评论

  1. 代码审查工具窗口中,选择一个审查。

  2. 在打开的时间线窗格中,输入您的评论并按Ctrl+Enter

发表一行评论

  1. 代码审查工具窗口中,选择一个审查。

  2. 在“文件”选项卡中,双击要打开以供评论的文件。然后,您可以使用Code Review | 提交选项卡以缩小更改列表的范围。

  3. 将鼠标悬停在一行代码上并单击图标一般添加

  4. 输入您的评论并按Ctrl+Enter

  5. 您的评论将保存为草稿。要使评论的其他参与者可以看到评论:

    • 如果您想立即通知审核参与者,请单击“立即发布”。

    • 如果您想继续审核并一次发送所有评论,请完成您的审核。

将文件标记为已查看或未查看

尚未审核的文件在“文件”选项卡上标有蓝点。如果您打开文件 diff,它被视为已查看。您可以将文件标记为已查看和未查看,以跟踪需要查看的内容。

  1. 代码审查工具窗口中,选择一个审查。

  2. 打开文件选项卡。

  3. 右键单击文件,然后在上下文菜单中单击标记为已查看标记为未查看

提及人

在一般和行评论中,您可以提及您的 Space 组织的用户以邀请他们参与讨论。然后他们将在 Space Chats中收到一条消息。

  1. 在撰写评论时,输入@

  2. 从列表中选择一个用户。

在评论中完成您的回合

如果您是回合制评论中的审稿人,您通常应该通过接受更改或要求作者提供更多信息来完成您的回合。当您完成您的回合时,您的线路评论将对评论的其他参与者可见。有关回合制评论的详细说明,请参阅Space 文档

  1. 代码审查工具窗口中,选择一个审查。

  2. 详细信息选项卡上,选择您希望如何完成审核:

    • 如果您想稍后返回此评论,请单击等待回复;例如,您希望作者进行更改并希望对其进行审核。

    • 如果您接受更改,请单击接受。

    这两个按钮还显示保存为草稿且其他审阅参与者尚不可见的行注释计数。

如果您选择了等待回复选项,现在将轮到作者审核您的评论并将评论发回给您。您可以重复此过程,直到双方都接受更改。

目前 PhpStorm 不支持关闭评论和合并分支;您可以使用网页版 Space关闭评论合并分支。

最后修改:2021 年 12 月 13 日