建立專案規則以搭配 Amazon Q Developer 聊天使用 - Amazon Q Developer

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

建立專案規則以搭配 Amazon Q Developer 聊天使用

您可以建置專案規則程式庫，供您在 IDE 中與 Amazon Q 聊天時使用。這些規則描述整個團隊的編碼標準和最佳實務。例如，您可以有一個規則，指出所有 Python 程式碼必須使用類型提示，或所有 Java 程式碼必須使用 Javadoc 註解。透過將這些規則儲存在專案中，無論開發人員的經驗層級為何，您都可以確保其一致性。

專案規則在專案project-root/.amazonq/rules資料夾中的 Markdown 檔案中定義。

建立專案規則後，每當開發人員在專案中與 Amazon Q 聊天時，Amazon Q 都會自動使用這些規則作為內容，並確保在產生答案時遵守這些規則。如需將內容新增至聊天的詳細資訊，請參閱 在 IDE 中將內容新增至 Amazon Q Developer 聊天。

您可以直接在檔案系統中或透過 Amazon Q 聊天介面建立專案規則。

使用 Amazon Q 聊天介面建立專案規則

  1. 在您的 IDE 中，開啟 Amazon Q 聊天面板。

  2. 在聊天輸入方塊中，按一下規則按鈕。

  3. 選取建立新規則。

  4. 在出現的對話方塊中，輸入規則的名稱。

    這將在專案的 project-root/.amazonq/rules 資料夾中建立具有該名稱的 Markdown 檔案。

  5. 在編輯器中新增規則內容。

  6. 儲存檔案。

使用 檔案系統建立專案規則

  1. 在您的 IDE 中，開啟專案的根資料夾。

  2. 在專案根資料夾中，建立下列資料夾：

    project-root/.amazonq/rules

    此資料夾會保留您的所有專案規則。

  3. 在 中project-root/.amazonq/rules，建立專案規則檔案。它必須是 Markdown 檔案。例如：

    cdk-rules.md

  4. 開啟您的專案規則 Markdown 檔案。

  5. 將詳細提示新增至 檔案。例如：

    All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled. 
All Amazon SNS topics must have encryption enabled and enforce SSL. 
All Amazon SNS queues must enforce SSL.

  6. 儲存檔案。

  7. （選用） 新增更多專案規則 Markdown 檔案。

    您現在已建立一或多個專案規則。每當專案中的開發人員與 Amazon Q 聊天時，Amazon Q 都會自動使用這些規則做為內容。

在 Amazon Q 聊天介面中管理規則

  1. 在您的 IDE 中，開啟 Amazon Q 聊天面板。

  2. 在聊天輸入方塊中，按一下規則按鈕以查看所有可用的規則。

  3. 按一下規則以開啟或關閉目前聊天工作階段的規則：

    • 具有核取記號的規則處於作用中狀態，並將套用至您的對話。

    • 沒有核取記號的規則在目前工作階段中處於非作用中狀態。