建立專案規則以搭配 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. 按一下規則，即可針對目前聊天工作階段將其切換為開啟或關閉：

    • 有核取記號的規則為作用中，將會套用至您的對話。

    • 沒有核取記號的規則表示未在目前工作階段中作用。