使用 Amazon Q 开发者版启动代码审查 - Amazon Q 开发者版

使用 Amazon Q 开发者版启动代码审查

Amazon Q 可以审查您的整个存储库,也可以在您编写代码时自动审查代码。

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

在编写代码时审查

注意

只有订阅 Amazon Q 开发者版专业套餐后,才可使用 Amazon Q 自动审查功能。

自动审查是基于规则的审查,由 Amazon 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 开发者版解决代码问题