Amazon Q Developer でコードレビューを開始する - Amazon Q Developer

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon Q Developer でコードレビューを開始する

Amazon Q は、ファイルまたはコードベース全体を確認したり、記述時にコードを自動的に確認したりできます。

開始する前に、コードレビューをサポートする IDE に Amazon Q がインストールされていることを確認してください。詳細については、「IDE に Amazon Q Developer 拡張機能またはプラグインをインストールする」を参照してください。

ファイル、プロジェクト、またはワークスペースを確認する

チャットパネルからレビューを開始して、Amazon Q に特定のファイルまたはプロジェクトを確認させることができます。ファイルとプロジェクトのレビューには、ルールベースのレビューと生成 AI を活用したレビューの両方が含まれます。

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 Developer を使用したコードの問題への対処」を参照してください。

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 Developer を使用したコードの問題への対処」を参照してください。

Visual Studio
  1. Visual Studio でスキャンするプロジェクトのファイルを開きます。

  2. ファイル下部の [Amazon Q] アイコンをクリックして、Amazon Q タスクバーを開きます。

  3. タスクバーから、[セキュリティスキャンを実行する] を選択します。Amazon Q がプロジェクトのスキャンを開始します。

    次の画像では、ユーザーが Visual Studio で [Amazon Q] アイコンをクリックし、[セキュリティスキャンを実行する] を選択できるタスクバーが表示されています。

    Amazon Q タスクバーに [セキュリティスキャンを実行する] が選択肢として表示されている Visual Studio
  4. Visual Studio 出力ペインにあるスキャンのステータスが更新されます。スキャンが完了すると通知があります。

    検出結果の表示と対処に関する詳細については、「Amazon Q Developer を使用したコードの問題への対処」を参照してください。

タスクとプロンプトの例

コードレビューを開始するときは、いくつかのシナリオが考えられます。以下は、コードレビューを開始する方法と、必要なレビューを実行するように Amazon Q に求める方法の概要です。

  • 1 つのファイルのコード変更のみを確認するには:

    • 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 Developer Pro サブスクリプションでのみ使用できます。

自動レビューは、Amazon Q ディテクターによるルールベースのレビューです。Amazon Q は、ユーザーがアクティブにコーディングしているファイルを自動的にレビューし、問題が検出されるとすぐにコードの問題を表示します。Amazon Q が自動レビューを実行する際、インプレースコード修正は生成されません。

Amazon Q を使用する際、自動レビューはデフォルトで有効になっています。自動レビューを一時停止または再開するには、次の手順を実行します。

自動レビューの一時停止と再開

自動レビューを一時停止するには、次の手順を実行します。

  1. IDE ウィンドウの下部で、[Amazon Q] を選択します。

    Amazon Q タスクバーが開きます。

  2. [自動レビューを一時停止] を選択します。自動レビューを再開するには、[自動レビューを再開] を選択します。