在Visual Studio 2022使用提示檔協助開發-1

在當前軟體開發的浪潮中，生成式人工智慧（Generative AI）正逐漸成為程式開發者不可或缺的輔助工具。隨著 Visual Studio 2022 開發工具對 AI 整合支援度的提升，程式開發者能夠透過提示檔（prompt file）與指示檔（instruction file）的搭配，將生成式AI有效導入專案開發流程之中，將帶來前所未有的便利與效率。這樣的做法不僅能協助開發者加速程式碼撰寫、優化既有功能，更能提升專案的可維護性與一致性，進而大幅縮短開發週期。要理解這些優點，首先需要先釐清何謂提示檔（prompt file）與指示檔（instruction file），並了解它們在實務上的角色與價值。

本系列文章分為三篇：

第一篇介紹提示檔（prompt file）與指示檔（instruction file）的基本概念，使用Visual Studio 2022建立一個「ASP.NET Core Web API」專案來撰寫服務導向程式。

第二篇介紹如何在Visual Stuio 2022開發工具中的「Github Copilot Chat」視窗中加入提示檔（prompt file）與指示檔（instruction file）。

第三篇則介紹如何在Visual Stuio 2022開發工具中的「Github Copilot Chat」視窗加入與執行提示檔（prompt file）與指示檔（instruction file），利用提示檔（prompt file）要求Github Copilot設計一個計算特休功能的Web API，並加入Razor Page網頁，利用fetch api叫用Web API，計算特休日數。

Prompt File與Instruction File的定義

所謂提示檔（prompt file），可以理解為一份描述「需求」或「提示」的文件，通常使用自然語言撰寫。它通常包含了對AI模型的輸入指令，例如要產生什麼樣的程式碼、需要依循的風格、預期的架構，甚至是某個特定問題的解決方式。透過提示檔（prompt file），開發者能將開發意圖具體化並明確傳達給AI，確保輸出的內容與專案需求相符。例如，在一個ASP.NET專案中，開發者可以建立提示檔（prompt file），要求AI依照既定的MVC架構撰寫控制器（Controller），或根據資料模型產生相應的API端點。這使得 AI產出的程式碼更具一致性，不會因臨時輸入的模糊描述而偏離專案目標。

相較之下，提示檔（prompt file）則更偏向「規範性」的角色。它可以被視為一種持續存在的開發準則或設定檔，用來定義整體專案在生成程式碼時應遵守的規則與標準。與提示檔（prompt file）不同的是，指示檔（instruction file）並非針對某一個單一任務，而是為整體專案提供長期的指導方針。例如，提示檔（instruction file）可以規定專案的程式碼必須使用特定的命名慣例、遵循某種設計模式、或在錯誤處理時保持一致的寫法。當AI在Visual Studio 2022開發工具 中被呼叫時，它可以參考這份指示檔（instruction file），以確保所有生成的程式碼都符合團隊既定的開發標準。這大大減少了因人而異所造成的品質差異，讓專案維護更加容易。

 

整合應用的優點

將提示檔（prompt file）與指示檔（instruction file）結合使用，為開發帶來了數個顯著的好處。首先，它能「提高開發效率」。開發者不再需要從零開始撰寫範本或重複性的程式碼，只需透過提示檔（prompt file）清楚下達需求，AI 就能在指示檔（instruction file）的規範下產生高品質的程式碼。其次，它能「降低學習成本」。新進人員或外部協作者在加入專案時，不必耗費大量時間理解複雜的架構或規範，因為 AI 會自動根據指示檔（instruction file）協助生成符合專案要求的程式碼，讓新人更快進入狀況。第三，它能 「提升專案一致性與可維護性」。由於所有生成的程式碼都受到指示檔（instruction file）的統一規範，專案不易出現風格不一或架構不整的情況，後續維護也能更加順暢。

此外，在 Visual Studio 2022開發工具 中使用這樣的整合方式，還能為團隊帶來 「共同作業的優勢」。開發者之間可以共享提示檔（prompt file）與指示檔（instruction file），確保每個人與AI的互動都基於相同的準則與上下文，避免出現「你寫的程式碼跟我要求的不一樣」的溝通落差。這種共享機制，也讓AI成為一種團隊智慧的延伸，而不僅僅是個人輔助工具。更重要的是，當專案規模龐大、需求變更頻繁時，開發者只需更新指示檔（instruction file），即可讓AI在後續的生成過程中自動遵循新的規範，大幅減少人為修正的時間與成本。

本篇文章將介紹如何在Visual Studio 2022開發工具之中，結合Github Copilot，使用提示檔（prompt file）與指示檔（instruction file）來輔助開發ASP.NET Core Web API服務類型的專案，在本文撰寫時，使用的工具版本為Visual Studio 2022開發工具17.14.14版（不同版本畫面與功能會略有差異）。

建立「ASP.NET Core Web API」專案

首先使用Visual Studio 2022開發工具建立一個「ASP.NET Core Web API」專案，建立步驟如下：啟動Visual Studio 2022開發環境，從「開始」視窗選取「Create a new project」選項，從「Create a new project」對話盒中，選取 使用C# 語法的「ASP.NET Core Web API」項目，然後按一下「Next」按鈕，請參考下圖所示：

圖 1：建立「ASP.NET Core Web API」專案

下一步，在「Configure your new project」視窗中，設定ASP.NET Core Web API專案名稱與專案存放路徑，然後按下「Next」按鈕，請參考下圖所示：

圖 2：設定ASP.NET Core Web API專案名稱與專案存放路徑

下一步，在「Additional information」視窗中，設定「Target Framework」為「NET 9.0（Standard Term Support）」；選擇「Configure for HTTPS」、「Enable OpenAI Support」與「Use Controllers」，然後按下「Create」按鈕，請參考下圖所示： 

圖 3：設定「Target Framework」為「NET 9.0 （Standard Term Support）」

專案建立完成之後，在目前方案（Solution）中加入XUnit測試專案。選取「Solution Explorer」視窗方案名稱上方按滑鼠右鍵，從快捷選單中選取「Add」>「New Project」，請參考下圖所示：

圖 4：在目前方案中加入專案

從「Add a new project」對話盒中，選取 使用C# 語法的「Xunit Test Project」項目，然後按一下「Next」按鈕，請參考下圖所示：

圖 5：加入「Xunit Test Project」

下一步，在「Configure your new project」視窗中，設定專案名稱與專案存放路徑，然後按下「Next」按鈕，請參考下圖所示：

圖 6：設定專案名稱與專案存放路徑

下一步，在「Additional information」視窗中，設定「Target Framework」為「NET 9.0（Standard Term Support）」，然後按下「Create」按鈕，請參考下圖所示：

圖 7：設定「Target Framework」為「NET 9.0 （Standard Term Support）」

接著先設定專案參考。選取「Solution Explorer」視窗測試專案名稱上方按滑鼠右鍵，從快捷選單中選取「Add」>「Project Reference」，請參考下圖所示：

圖 8：設定專案參考

在「Reference Manager」視窗中，勾選要參考的Web API專案。，然後按下「OK」按鈕，請參考下圖所示： 

圖 9：勾選要參考的Web API專案

 

總結

本文介紹在Visual Studio 2022 中，如何結合生成式AI工具與Github Copilot，利用提示檔（prompt file）與指示檔（instruction file）輔助ASP.NET Core Web API開發。提示檔主要負責描述需求或開發意圖，幫助 AI生成符合專案目標的程式碼；指示檔則提供長期規範，例如命名慣例與架構標準，確保程式碼一致性與品質。兩者搭配使用，能提升開發效率、降低新手學習成本，並強化專案的可維護性。團隊成員也能共享這些檔案，建立共同準則，避免溝通落差。當專案需求改變時，只需更新指示檔，即可讓AI自動套用新規範，節省大量修正成本。文中並示範了如何在Visual Studio 2022中建立ASP.NET Core Web API專案與測試專案，為後續實作AI輔助開發奠定基礎。