在 VS Code 中使用 GitHub Copilot 的最佳實務

本文涵蓋在 Visual Studio Code 中使用 GitHub Copilot 的最佳實務，方法是使用提示詞工程，並為 GitHub Copilot 提供正確的上下文。

如果您是 VS Code 或 GitHub Copilot 的新手，您可能想要先檢閱 GitHub Copilot 概觀 文章，或直接深入研究 開始使用 教學課程。

有不同的選項可以最佳化您的 Copilot 行內建議和 Chat 體驗

• 充分利用行內建議
• 充分利用 Copilot Chat

充分利用 Copilot 行內建議

GitHub Copilot 擴充功能會自動提供 建議，以協助您更有效率地編碼。您可以做一些事情來協助（「提示」）Copilot 提供最佳的建議。好消息是，您可能已經在這樣做了，因為它們有助於您和您的同事理解您的程式碼。

為 Copilot 提供上下文

當 Copilot 有足夠的上下文來了解您在做什麼以及您需要什麼協助時，它的效果最佳。就像您在向同事尋求特定程式設計任務的協助時會提供上下文一樣，您也可以對 Copilot 執行相同的操作。

開啟檔案

對於程式碼完成，Copilot 會查看您編輯器中的目前和開啟檔案，以分析上下文並建立適當的建議。在使用 Copilot 時，在 VS Code 中開啟相關檔案有助於設定此上下文，並讓 Copilot 看到您專案的更大格局。

最上層註解

就像您會向同事簡要介紹高階資訊一樣，您正在處理的檔案中的最上層註解可以協助 Copilot 了解您正在建立的片段的整體上下文。

適當的 include 和參考

最好手動設定您工作所需的 include 或模組參考。Copilot 可以提供建議，但您可能最清楚自己需要包含哪些相依性。這也有助於讓 Copilot 知道您希望它在製作建議時使用哪些架構、程式庫及其版本。

在下列 TypeScript 範例中，我們想要記錄 add 方法的輸出。當我們沒有任何 include 時，Copilot 會建議使用 console.log

另一方面，當您新增對 Log4js 的參考時，Copilot 會建議使用該架構來記錄輸出

有意義的函式名稱

就像名為 fetchData() 的方法對同事（或幾個月後的您）沒有多大意義一樣，fetchData() 也對 Copilot 沒有幫助。使用有意義的函式名稱有助於 Copilot 提供符合您需求的函式主體。

特定且範圍明確的函式註解

函式名稱的描述性可能有限，而不會過於冗長。函式註解可以協助填寫 Copilot 可能需要知道的詳細資訊。

使用範例程式碼啟發 Copilot

讓 Copilot 進入正確狀態的一個技巧是，將與您要尋找的內容接近的範例程式碼複製並貼到您的開啟編輯器中。提供一個小範例可以協助 Copilot 產生符合您想要實現的語言和任務的建議。一旦 Copilot 開始為您提供您想要且實際會使用的程式碼，您就可以從檔案中刪除範例程式碼。當 Copilot 預設提供較舊的程式碼建議時，這對於快速啟動 Copilot 以使用較新的程式庫版本特別有幫助。

保持一致性並維持高品質標準

Copilot 將會依附於您的程式碼，以產生遵循現有模式的建議，因此「垃圾進，垃圾出」這句諺語適用。

始終保持高品質標準可能需要自律。特別是當您快速且隨意地編碼以使某些東西運作時，您可能想要在「駭客」模式下停用 Copilot 完成。您可以從 Copilot 狀態選單暫時停用完成。透過選取 Copilot 狀態列項目來顯示 Copilot 狀態選單下拉式選單。

從下拉式選單中，您可以完全停用完成，或僅針對作用中檔案類型停用，例如 Markdown 檔案。

充分利用 Copilot Chat

您也可以透過 聊天介面 從 Copilot 取得協助，方法是安裝 GitHub Copilot Chat 擴充功能。

當您使用聊天與 GitHub Copilot 互動時，您可以執行幾件事來最佳化您的體驗。

使用聊天參與者和斜線命令

聊天參與者旨在收集關於程式碼庫或特定領域或技術的額外上下文。透過使用適當的參與者，Copilot Chat 可以找到並提供更好的資訊以傳送至 Copilot 後端。例如，如果您想要詢問關於您的開啟專案的問題，請使用 @workspace，或者使用 @vscode 來了解更多關於 VS Code 功能和 API 的資訊。

斜線命令可協助 Copilot Chat 了解您在提出問題時的意圖。您是在學習程式碼庫 (/explain) 嗎？您需要協助修正問題 (/fix) 嗎？還是您在建立測試案例 (/tests)？透過讓 Copilot Chat 知道您嘗試做什麼，它可以調整其回覆以符合您的任務，並提供有用的命令、設定和程式碼片段。

您可以使用自然語言查詢寫出您的專案範圍或目前任務，但使用聊天參與者和斜線命令更簡潔且更明確。

在 Copilot Chat 中深入了解 聊天參與者 和 斜線命令。

使用聊天變數取得上下文

聊天參與者，例如 @workspace 或 @vscode，可以貢獻提供特定領域上下文的聊天變數。您可以使用 # 符號在您的聊天提示中參考聊天變數。透過使用聊天變數，您可以更具體地說明您包含在聊天提示中的上下文。

例如，#file 變數可讓您在聊天提示中參考工作區中的特定檔案。這有助於使 Copilot Chat 的答案與您的程式碼更相關，方法是提供關於您正在處理的檔案的上下文。您可以詢問諸如「您可以建議對 #file:package.json 進行哪些改進？」或「我如何在 #file:devcontainer.json 中新增擴充功能？」之類的問題。透過使用 #file 變數，您可以從 Copilot 獲得更具針對性和準確的回應。

您也可以透過使用「聊天」檢視中的「附加上下文」按鈕，將上下文新增至您的聊天訊息。然後，您可以從「快速選取」中選取特定類型的上下文，例如目前選取項目、工作區中的一或多個檔案，或原始程式碼中的一或多個符號。

深入了解 搭配 Copilot Chat 使用上下文變數。

具體且保持簡潔

當您要求 Copilot 做某事時，請具體說明您的要求，並將大型任務分解為個別的較小任務。例如，不要要求 Copilot 建立一個使用 TypeScript 和 Pug 的 Express 應用程式，並且該應用程式有一個從 MongoDB 資料庫擷取產品資料的產品頁面。相反地，首先要求 Copilot 建立具有 TypeScript 和 Pug 的 Express 應用程式。接下來，要求新增產品頁面，最後要求從資料庫擷取客戶資料。

當您要求 Copilot 執行特定任務時，請具體說明您想要使用的輸入、輸出、API 或架構。您的提示越具體，結果就會越好。例如，不要使用「從資料庫讀取產品資料」，而是使用「依類別讀取所有產品，以 JSON 格式傳回資料，並使用 Mongoose 程式庫」。

反覆運算您的解決方案

當向 Copilot Chat 尋求協助時，您不會受限於第一個回應。您可以反覆運算並提示 Copilot 改善解決方案。Copilot 同時具有產生的程式碼的上下文和您目前的對話。

以下是使用行內聊天建立用於計算費氏數列的函式的範例

也許您更喜歡不使用遞迴的解決方案

您甚至可以要求 Copilot 遵循編碼慣例或改進變數名稱

即使您已經接受結果，您隨時可以要求 Copilot 稍後反覆運算程式碼。

關於 Copilot 提示的更多資源

如果您想了解更多關於有效率地使用 GitHub Copilot 的資訊，您可以繼續觀看這些影片和部落格文章

• GitHub Copilot 的有效提示詞
• 充分利用 GitHub Copilot 的實用技術
• 在 VS Code 中提示 GitHub Copilot 的最佳實務
• 如何使用 GitHub Copilot：提示詞、秘訣和使用案例