View a markdown version of this page

使用 Amazon Q 开发者版启动代码审查 - Amazon Q 开发者版
查看文件、项目或工作空间示例任务和提示在编写代码时审查

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

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

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

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

查看文件、项目或工作空间

您可以通过聊天面板发起审核，让 Amazon Q 审阅特定的文件或项目。文件和项目审查包括基于规则的审查和生成式 AI-powered 审查。

Amazon Q 完成审核后，您可以调查问题并获取代码修复以修复问题。有关更多信息，请参阅解决代码问题。

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

JetBrains

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

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

  3. 使用自然语言描述您要执行的代码审查类型。您可以仅审查最近的代码更改，也可以审查整个文件。代码更改是根据文件上 git diff 命令的输出来确定的。如果适用，除非另有说明，否则默认情况下，Amazon Q 只会审查您的代码更改。

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

    1. Review my code changes— Amazon Q 将审查您的代码库中的任何代码更改

    2. Run a code review on this entire file— Amazon Q 将审查您文件中的所有代码，而不仅仅是更改

    3. Review this repository— Amazon Q 将审查您的整个代码库，而不仅仅是更改

    有关更详细的代码审查场景和相关提示，请参阅示例提示。

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

  6. 如果检测到任何问题，则会打开 “代码问题” 选项卡，其中列出了 Amazon Q 发现的问题。

  7. 要了解有关代码问题的更多信息，请导航到 “代码问题” 面板。在那里，您可以执行下列操作：

    1. 选择一个问题，以重定向到在其中检测到漏洞或低质量代码的文件的特定区域。

    2. 要获取代码问题的解释，请选择代码问题名称旁边的放大镜图标。Amazon Q 将提供有关该问题的详细信息，并建议可插入代码中的修复方案。

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

    4. 您还可以使用自然语言来询问有关问题的更多信息，获取对拟议修复的解释或询问其他解决方案。

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

Visual Studio Code

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

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

  3. 使用自然语言描述您要执行的代码审查类型。您可以仅审查最近的代码更改，也可以审查整个文件。代码更改是根据文件上 git diff 命令的输出来确定的。如果适用，除非另有说明，否则默认情况下，Amazon Q 只会审查您的代码更改。

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

    1. Review my code changes— Amazon Q 将审查您的代码库中的任何代码更改

    2. Run a code review on this entire file— Amazon Q 将审查您文件中的所有代码，而不仅仅是更改

    3. Review this repository— Amazon Q 将审查您的整个代码库，而不仅仅是更改

    有关更详细的代码审查场景和相关提示，请参阅示例提示。

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

  6. 如果检测到任何问题，则会打开 “代码问题” 选项卡，其中列出了 Amazon Q 发现的问题。

  7. 要了解有关代码问题的更多信息，请导航到 “代码问题” 面板。在那里，您可以执行下列操作：

    1. 选择一个问题，以重定向到在其中检测到漏洞或低质量代码的文件的特定区域。

    2. 要获取代码问题的解释，请选择代码问题名称旁边的放大镜图标。Amazon Q 将提供有关该问题的详细信息，并建议可插入代码中的修复方案。

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

    4. 您还可以使用自然语言来询问有关问题的更多信息，获取对拟议修复的解释或询问其他解决方案。

  8. 有关解决代码问题的更多信息，请参阅使用 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 开发者版解决代码问题。

示例任务和提示

在启动代码审查时，您可能会遇到多种情况。以下概述了启动代码审查的一些方法以及如何提示 Amazon Q 运行您想要的审查。

  • 要仅查看单个文件的代码更改，请执行以下操作：

    • 在 IDE 中打开该文件并输入 Review my code

    • 输入 Review the code in <filename>

  • 要查看整个代码文件，请执行以下操作：

    • 打开未做任何更改的文件并输入 Review my code

    • 打开包含更改的文件并输入 Review my entire code file

    • 输入 Review all the code in <filename>

  • 要查看仓库中的所有代码更改，请执行以下操作：

    • 在 IDE 中打开存储库并输入 Review my code

  • 要查看整个存储库，而不仅仅是更改，请执行以下操作：

    • 在 IDE 中打开存储库并输入 Review my repository

在编写代码时审查

注意

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

Auto-reviews 是由 A mazon Q 探测器提供支持的基于规则的评论。Amazon Q 会自动审查您正在编码的文件，一旦在您的代码中发现问题，就会立即生成对应的问题记录。执行自动审查时，Amazon Q 不会就地生成代码修复方案。

Auto-reviews 在您使用 Amazon Q 时默认处于启用状态。使用以下步骤暂停或恢复自动审核。

暂停和恢复自动审查

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

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

    Amazon Q 任务栏将打开。

  2. 选择暂停 Auto-Reviews。要恢复自动审阅，请选择 “继续 Auto-Reviews”。