开始与 Amazon Q 开发者一起进行代码审查 - Amazon Q 开发者版
边写代码边看查看文件或项目

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

开始与 Amazon Q 开发者一起进行代码审查

Amazon Q 可以查看您的整个代码库，或者在您编写代码时自动查看您的代码。

在开始之前，请确保您已在支持代码审查的 IDE 中安装了 Amazon Q。有关更多信息，请参阅 在 IDE 中安装 Amazon Q 开发者版扩展程序或插件。

边写代码边看

注意

Amazon Q 自动评论仅适用于订阅 Amazon Q Developer Pro。

自动评论是基于规则的评论，由 A ma zon Q 探测器提供支持。Amazon Q 会自动审查您正在编写的文件，一旦在您的代码中检测到代码问题，就会立即生成代码问题。当 Amazon Q 执行自动审查时，它不会生成就地代码修复。

当您使用 Amazon Q 时，自动审核默认处于启用状态。请按以下步骤暂停或恢复自动审核。

暂停并恢复自动审核

要暂停自动审核，请完成以下步骤。

  1. 从 IDE 窗口的底部选择 Amazon Q。

    Amazon Q 任务栏打开。

  2. 选择 “暂停自动点评”。要恢复自动审阅，请选择 “恢复自动审阅”。

查看文件或项目

您也可以通过聊天面板发起审核，让 Amazon Q 审阅特定的文件或项目。文件和项目审查包括基于规则的审查和基于人工智能的生成式审查。文件或项目审查期间生成的代码问题可能包括就地代码修复。

要开始审阅文件或项目，请完成以下步骤：

JetBrains

  1. 在 IDE 中打开要查看的文件或项目。

  2. 选择 Amazon Q 图标以打开聊天面板。输入 /review。

  3. 将打开一个新的聊天选项卡。Amazon Q 会提示您选择要查看的项目或文件。如果您正在查看文件，则要查看的文件必须在 IDE 中处于打开状态并处于活动状态。如果您正在审阅项目，则必须在 IDE 中打开该项目。

  4. 选择您要运行的评论类型。Amazon Q 开始审核您当前在 IDE 中打开的项目或文件。

  5. 审核完成后，“代码问题” 选项卡将在聊天面板上方打开，其中列出了 Amazon Q 发现的问题。

  6. 您可以选择将问题重定向到文件中检测到有漏洞或低质量代码的特定区域。

    要查看有关该问题的更多详细信息，请在 “代码问题” 选项卡中选择代码问题名称右侧的放大镜图标。将打开 “代码问题详细信息” 面板，其中包含有关该问题的信息。

  7. 要解决您的代码问题，请参阅解决 Amazon Q 开发者的代码问题。

Visual Studio Code

  1. 在 IDE 中打开要查看的文件或项目。

  2. 选择 Amazon Q 图标以打开聊天面板。

  3. 使用自然语言描述您要运行的代码审查类型。您只能查看最近的代码更改或整个文件。代码更改是根据文件上的 git diff 命令的输出来确定的。

    在 IDE 中打开代码项目或文件后，您可以输入以下内容：

    • Review my code changes

    • Run a code review on this file

  4. Amazon Q 将开始审核您的文件或项目。完成后，它将总结最优先的问题和意见。

    如果检测到任何问题，将在聊天面板上方打开 “代码问题” 面板，其中列出了 Amazon Q 发现的问题。

  5. 要了解有关代码问题的更多信息，请导航到聊天面板上方的代码问题面板。然后，您可以执行以下操作：

    1. 选择要重定向到文件中检测到有漏洞或低质量代码的特定区域的问题。

    2. 要了解代码问题的解释，请选择代码问题名称旁边的放大镜图标。Amazon Q 将提供有关该问题的详细信息，并建议您可以将其插入代码中的补救措施。

    3. 要修复代码问题，请选择代码问题名称旁边的扳手图标。Amazon Q 将对修复进行简要说明，然后在您的代码文件中进行就地修复。您将在文件中看到代码的更改，并可以选择从聊天面板撤消更改。

  6. 有关解决代码问题的更多信息，请参阅解决 Amazon Q 开发者的代码问题。

Visual Studio

  1. 在 Visual Studio 中打开要扫描的项目中的文件。

  2. 选择文件底部的 Amazon Q 图标以打开 Amazon Q 任务栏。

  3. 从任务栏中选择运行安全扫描。Amazon Q 开始扫描您的项目。

    在下图中，在 Visual Studio 中，用户选择 Amazon Q 图标，系统显示了任务栏，用户可以从中选择运行安全扫描。

    Visual Studio 中的 Amazon Q 任务栏显示“运行安全扫描”选项

  4. 您的扫描状态将在 Visual Studio 输出窗格中更新。扫描完成后，您会收到通知。

    有关查看和处理扫描结果的信息，请参阅 解决 Amazon Q 开发者的代码问题。