GhostDoc類型的工具的替代工具

Question

是否有一個.NET的工具，如果我們給它的函數或事件處理程序（如GhostDoc，我們認爲它不是一個好工具），它將生成代碼的解釋（註釋）？

Answer 1

如果您在VS2010中使用///開始評論，它會根據您評論的功能爲您創建基於XML的基本參數。

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

功能startMonitor(ManagementScope scope)給之前所以，鍵入/// ...

/// <summary> 
/// 
/// </summary> 
/// <param name="scope"></param> 
static void startMonitor(ManagementScope scope) 

如果你想生成這些體面的文件，我建議https://github.com/EWSoftware/SHFB作爲您的第一站。這很好。

Answer 2

看看Sandcastle。它將與Visual   Studio   2005項目一起工作。還有可用於nDoc的下載。它在2005年左右達到鼎盛時期，但我認爲自那時以來很少或根本沒有發展。

如果您正在尋找能夠爲您預先填充代碼註釋的內容，我不確定您可以做得比GhostDoc更好。

Answer 3

實際上，///不會生成任何文檔，只是空的XML標籤。其中GhostDoc照是自動生成MSDN樣式的文檔（包括空話），基於上下文信息，如財產，階級，知名度，用途等

這裏有一些真正的解決辦法：

• Atomineer（位比GhostDoc便宜）
• Resharper（僅在您爲項目啓用XML註釋時才起作用，但遠不如上述兩種情況，也可以從基類/接口複製XML註釋）。

現在，無論你做什麼，請不要產生undocumentation！ :)