使用 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 程式碼

  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 圖示，因而出現任務列提示，使用者可在此選擇執行安全掃描。

    Visual Studio 與顯示「執行安全掃描」選項的 Amazon Q 任務列

  4. 在 Visual Studio 輸出窗格中，掃描的狀態會更新。掃描完成時，您會收到通知。

    如需有關檢視和解決問題清單的資訊，請參閱 使用 Amazon Q Developer 解決程式碼問題。

範例任務和提示

啟動程式碼檢閱時，您可能會遇到幾種情況。以下是啟動程式碼檢閱的一些方法概觀，以及如何提示 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 Developer 專業方案訂閱。

自動檢閱是由 Amazon Q 偵測器支援的規則型檢閱。Amazon Q 會自動檢閱您主動編碼的檔案，一旦在您的程式碼中偵測到程式碼問題，就會產生問題。當 Amazon Q 執行自動檢閱時，不會產生就地程式碼修正。

當您使用 Amazon Q 時，自動檢閱預設為啟用狀態。請使用下列程序來暫停或繼續執行自動檢閱。

暫停和繼續執行自動檢閱

若要暫停自動檢閱，請完成下列步驟。

  1. 從 IDE 視窗底部選擇 Amazon Q。

    Amazon Q 任務列隨即開啟。

  2. 選擇暫停自動檢閱。若要繼續執行自動檢閱，選擇繼續自動檢閱。