從C＃類庫生成文檔

我開發了一個包含大量項目的C＃類庫。我將它用作跨多個不同項目的通用庫。從C＃類庫生成文檔

許多不同的開發人員最近加入了團隊，不熟悉庫，他們不確定包含什麼。我在ghostdoc的幫助下評論得很好。

是否可以使用庫的任何工具自動生成文檔？我想運行一個工具來爲我生成文檔，以便讓開發人員知道要閱讀。我認爲這樣的工具會從評論中產生文檔。

2012-11-14 amateur

看這些問題 - http://stackoverflow.com/questions/641364/c-sharp-documentation-generator/641402#641402和http://stackoverflow.com/questions/665925/what-are-some-good-net-code-documentation-tools –

我推薦使用Sandcasle Help File Builder從源代碼生成文檔。您需要查看XML Documentation Comments，因爲生成的文檔的質量和穩健性與您使用的XML註釋的豐富性直接相關。

SHFB可以生成HTML和/或編譯的幫助文檔。

來源

2012-11-14 00:39:54 Oppositional

如果您使用Visual Studio轉到項目的屬性，請選擇Build，然後輸入輸出勾選XML文檔文件複選框。

來源

2012-11-14 00:39:39 JohnLBevan

是的，我正在使用VS，這個輸出是什麼？ – amateur

下面是代碼和相關生成的xml的示例：http://msdn.microsoft.com/en-us/library/z04awywx.aspx爲了使XML更具可讀性，您可以應用XSL樣式表或可以使用工具的數量（請參閱http://stackoverflow.com/questions/4304780/what-can-i-do-with-my-xml-documentation）。 – JohnLBevan

我最近做了一個簡單的使用庫，從C＃代碼生成降價文檔。它只需要一個類庫dll文件。
如果您想試試，here's a link關於如何開始使用它與生成文檔的示例。

來源

2017-06-25 19:43:09 CBinet

從C＃類庫生成文檔

回答

相關問題