增進撰寫註解速度的小套件 GhostDoc

摘要:增進撰寫註解速度的小套件 GhostDoc

GhostDoc 是 C# 程式設計師撰寫 XML 註解好幫手,由 Roland Weigelt 所開發,Visual Studio 2008、Visual Studio 2005 與 Visual Studio 2003 都有版本可供支援。

雖然在 Visual Studio 中,輸入 /// 會產生一些 Summary 的 XML 標籤,但是 GhostDoc 卻可以位我們做得更多更好。通常 GhostDoc 會根據你程式碼的的命名規則 (通常是 Camel 或是 Pascal 命名法),來推測你應該會需要的註解樣版。對於自動產生的註解樣版稍加修改,也可以寫出良好的註解文件。

但是,GhostDoc 能做的不僅僅如此還可以更好,例如:函數、類別方法、委派、事件等方法參數,建立動態對應的註解。舉例來說,我們有時候在寫一些方法函數時,會順便寫一些簡單的註解來描述參數的型態以及意義,但是日後如果該方法函數修改時,修改註解就變成是一件苦差事,GhostDoc 可以快速幫你增減註解,只要稍微修改內容就可以了。

安裝步驟相當簡單,幾乎只要點擊【Next】即可完成:

GhostDoc-0000 

圖一、安裝 GhostDoc 2.1.3 for Visual Studio 2008

GhostDoc-0001

圖二、同意 License

GhostDoc-0002

圖三、選擇安裝路徑

GhostDoc-0003

圖四、確認安裝

GhostDoc-0004

圖五、開始安裝

GhostDoc-0005

圖六、安裝完成

打開 Visual Stduio 後,會出現設定 GhostDoc 的設定畫面,如果是第一次使用可以都使用預設安裝設定,將 hotkey 設定為 Ctrl + Shift + D,如下圖:

GhostDoc-0006

圖七、設定 hotkey

如果是升級現有版本就點擊【Upgrade】,第一次安裝就選澤【Create】建立預設 GhostDoc 註解模版設定值,點擊【Import】可匯入自己的舊有設定,如下圖:

GhostDoc-0009

圖八、設定註解模版

GhostDoc-0010

圖九、設定完成

安裝 GhostDoc 就可以到處在程式碼中按按看 hotkey (Ctrl + Shift + D) 來體驗一下 GhostDoc 的威力,如果不滿意還可以去 Tools -> GhostDoc -> Configure GhostDoc 設定適合你的註解樣版。

GhostDoc-0011

圖十、GhostDoc 詳細設定視窗

其中 Rules 標籤記錄所有產生註解的規則與如何產生註解的設定;Acronyms 設定哪些單字詞必須大使用寫縮寫;"Of the" Rereordering 設定某些單字詞出現,必須使用 of the 的語句;"Not the" Words 設定哪些單字前不可加入介系詞 the;Options 設定 Macros 與 Customer Text。