如何格式化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文档以在网络上显示

回答

相关问题