如何格式化Visual Studio XML文檔以在網絡上顯示

我正在使用Visual Studio 2010，並開始成爲一名好孩子，並在我通過XML註釋編寫代碼時記錄了所有代碼。我有一個記錄良好的項目，我甚至想到如何讓Visual Studio在構建時吐出一個完整的XML文檔。我的問題是，在Web上格式化/顯示此文檔的最佳方式是什麼，以便它以一種友好的可用格式（如MSDN）出現？有沒有一種工具可以輕鬆實現這一點？如何格式化Visual Studio XML文檔以在網絡上顯示

在此先感謝！

來源

2011-03-04 Chev

可能的重複[Visual Studio是否可以生成Javadoc樣式註釋的html文檔？]（http://stackoverflow.com/questions/1935351/does-visual-studio-have-an-option -to-generate-html-documentation-for-javadoc-sty） – Alfabravo 2013-07-24 15:44:17

結賬Sandcastle Help File Builder。這是一個GUI工具，可以讓Sandcastle非常容易地使用。它會安裝到開始菜單 - >程序文件 - > Sandcastle幫助文件生成器中的文件夾。它使用起來非常簡單，但速度並不快。

希望幫助！

來源

2011-03-04 21:44:35 pmartin

我設法讓它在Visual Studio的構建事件中創建文檔。看看我對這個問題的回答：http://stackoverflow.com/questions/211693/generate-html-documentation-automatically-during-a-build-with-sandcastle/5200822#5200822 – Chev 2011-03-07 16:44:10

回購已從Codeplex轉移到[ GitHub的]（https://github.com/EWSoftware/SHFB） – Jessycormier 2017-05-17 19:16:42

結賬Sandcastle。

Sandcastle通過反射源程序集並可選地集成XML文檔註釋，生成準確的MSDN樣式全面的文檔。

Wikipedia有更多信息和鏈接到與sandcastle集成的其他項目。

另一種選擇（這似乎是更容易使用）是docu：

用於.NET中的文檔生成器，其並不複雜，笨拙，或難於使用。給定一個程序集和由Visual Studio生成的XML，docu可以使用單個命令生成整個文檔網站。

第三種選擇是NDoc：

NDoc的從由C＃編譯器生成的.NET組件和XML文檔文件生成類庫文件（或與VB的附加工具。淨）。

NDoc使用可插入的文檔生成多種不同格式的文檔，包括MSDN樣式的HTML幫助格式（.chm），Visual Studio .NET幫助格式（HTML幫助2）和MSDN在線樣式的網頁。

來源

2011-03-04 20:41:04 Oded

這很有趣，這是我遇到的第一個。這看起來相當麻煩。我不認爲它從生成的XML文檔讀取，而是從.cs文件本身讀取。這是一個肯定的選擇，但我想看看是否有其他人提出了其他選擇。 – Chev 2011-03-04 20:43:52

@Chevex - 多年來一直是國王......我用另一種選擇更新了我的答案。 – Oded 2011-03-04 20:46:06

我想使用沙堡，但它讓我很困惑。我安裝了它，但沒有清楚它去了哪裏。它有一個GUI？ – Chev 2011-03-04 20:55:59

NDoc也是一種選擇。但我會和沙堡一起去，那就是我所做的。

來源

2011-03-04 20:48:26 adt

我已經創建了一個開源項目以顯示他們的網頁檢查@AutoHelp

AutoHelp讀取DLL & XML文檔文件，生成的幫助頁面，並將其暴露給用戶。 AutoHelp使用ASP.NET MVC 5，ASP.NET WebApi，TypeScript，jQuery和Bootstrap作爲一個現代的Web應用程序。

來源

2014-06-17 19:45:30 Raynald

如何格式化Visual Studio XML文檔以在網絡上顯示

回答

相關問題