兩個VS的文檔工具

做個筆記：

GhostDoc 會自動生成 XML 注釋

當 XML 注釋協助将源代碼注釋自動轉換為 RTF 幫助文檔時，仍須寫入注釋文本，這是一項令很多開發人員感到精疲力盡的工作。為什麼不使用自動化來加速這些注釋的建立呢？這正是 GhostDoc 1.9.5 試圖實作的目标。

GhostDoc 是一個免費的 Visual Studio 附加元件，由 Roland Weigelt 建立，用來協助編寫 XML 注釋。一旦安裝了 GhostDoc，隻要使用它指一指、點一點，就能輕松地自動生成 XML 注釋。例如，若要将 XML 注釋添加到某個方法中，隻需在該方法中右鍵單擊，然後從上下文菜單中選擇“Document This”選項。然後，GhostDoc 就會根據該方法的類型、參數、名稱和其他上下文資訊為其自動生成 XML 注釋文本。

如果您正在 .NET Framework 中為使用某個類型的屬性或方法生成文檔，則 GhostDoc 将會使用 Microsoft 已為該類型編寫的文檔。如果您使用 Pascal 大小寫格式或 Camel 大小寫格式，GhostDoc 可将該名稱拆分成幾個單詞，并分析這些單獨的單詞，以生成文檔。所有的文檔邏輯都按照 GhostDoc 的生成規則來處理。既可以對這些内置規則進行自定義，也可以添加新的規則。還可以導出這些規則，以便在其他計算機上使用。

除最簡單的成員外，您不能完全依賴 GhostDoc 為您編寫 XML 注釋。GhostDoc 自動生成的注釋隻是建議，還需開發人員進行稽核。無論如何，GhostDoc 是一個值得一試的注釋編寫插件，它可以節省大量時間。

網址：

http://www.roland-weigelt.de/ghostdoc

NDoc

根據XML注釋自動生成幫助檔案的開源軟體，就不用多介紹了。

http://ndoc.sourceforge.net/

因為 NDoc不支援.Net Framework 1.0 以上的版本，是以似乎用處不大了，這裡有

支援2.0的版本，

http://community.rainbowportal.net/blogs/jonathans_rainbow_blog/archive/2006/03/21/1685.aspx

支援VS 2005的版本：

http://sourceforge.net/project/showfiles.php?group_id=163095

不過都是beta版，功能不全。

參考文章：

Open Source Tools and Visual Studio 2008 / .NET 3.5 Generating MSDN-style Documentation with Sandcastle, NAnt and CruiseControl.NET