Visual Studio 2005 使用 GhostDoc 實現自訂 XML 註釋模板

GhostDoc 核心價值

• 預設熱鍵 Ctrl+Shift+D 一鍵生成符合命名慣例的 XML 註釋。
• 支援**規則自訂**：針對方法、屬性、參數、類別等定義專屬註釋模板。

自訂規則步驟 (圖文)

1. 選單 Tools → GhostDoc → Options 開啟設定面板。
2. 選擇 Method (或 Property/Class/Parameter) → 點擊 Add 新增規則。
3. 選取 Summary 欄位 → 點擊右側 ... 按鈕編輯模板。
4. 在模板編輯器中：雙擊插入巨集變數 ($MethodName$, $ParameterList$, $ReturnType$ 等)。
5. 確定返回，光標置於方法名稱上按 Ctrl+Shift+D 即可生效。

常用巨集變數

匯出/匯入設定

面板提供 Export/Import 功能，將自訂規則儲存為 .xml，重裝環境或團隊共享一鍵套用。

適用版本與現代替代

• GhostDoc 免費版支援 VS2005/2008/2010/2012/2013/2015/2017/2019/2022。
• VS2019+ 內建 IntelliCode、Documentation Comments (/// 智慧補全) 已涵蓋大部分常規需求。
• 更進階的文件生成可用 DocFX, Sandcastle 配合 XML 註釋。

結語

GhostDoc 以「規則驅動模板」將 XML 註釋從繁瑣勞動解放。花 10 分鐘配置專屬規則，換取專案生命周期內一致、完整、可維護的 API 文件基礎，投報比極高。

1. 上一篇文章： C# Lambda 表達式與抽象委派：Dispatcher.Invoke 類型推論失敗的解決之道
2. 下一篇文章： 深入解析 C# 委托的異步調用與跨線程操作

關於C#

PureMVC 架構深度剖析與 C# 改良方案：解耦觀察者模式、修正 Mediator 註冊缺陷

PureMVC 以 Notification 為核心貫徹觀察

C# 程式設計利器之四：委派與事件 (上) - 委派核心概念與實戰

C# 委派深度解析：從函式指標到多播委派實戰 委派是 C#

.NET 非同步 Socket 程式設計：從 BeginAccept 到 P2P 實作

為什麼需要非同步 Socket？ 傳統阻塞式 Accept(

我眼中的 C#：從 C/C++ 演進的純物件導向語言與開發環境選擇

C# 的血統與定位 C 語言源自 B 語言，屬面向過程；C+