I am using Visual Studio 2010 and have started being a good boy and documenting all my code as I write it, via XML comments. I have a well-documented project and I even figured out how to make Visual Studio spit out a complete XML document when doing a build. My question is, what is the best way to format/display this document on the web so that it appears in a nice friendly and usable format like MSDN? Is there a tool that does this easily?
我正在使用Visual Studio 2010，并开始成为一个好男孩，并通过XML注释记录我编写的所有代码。我有一个文档完备的项目，我甚至知道如何在构建时让Visual Studio生成一个完整的XML文档。我的问题是，在web上格式化/显示这个文档的最佳方式是什么，以便它以一种友好且可用的格式出现，比如MSDN?有没有一种工具可以很容易地做到这一点?
Thanks in advance!
提前谢谢!
4 个解决方案
#1
5
Check out Sandcastle Help File Builder. This is a GUI tool that makes Sandcastle pretty easy to work with. It will install to a folder in Start Menu->Program Files->Sandcastle Help File Builder.; It's pretty easy to use, but it's not incredibly fast.
查看Sandcastle帮助文件构建器。这是一个GUI工具，使Sandcastle非常容易使用。它将安装到开始菜单中的一个文件夹—>程序文件—>Sandcastle帮助文件构建器;使用起来很简单，但也不是特别快。
Hope that helps!
希望会有帮助!
#2
16
Check out Sandcastle.
查看沙塔。
Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments.
Sandcastle通过反映源程序集和可选地集成XML文档注释生成准确、MSDN风格、全面的文档。
Wikipedia has more information and links to additional projects that integrate with sandcastle.
*有更多的信息和链接到与sandcastle集成的其他项目。
Another option (which appears to be much easier to use) is docu:
另一种选择(似乎更容易使用)是:
A documentation generator for .Net that isn't complicated, awkward, or difficult to use. Given an assembly and the XML that's generated by Visual Studio, docu can produce an entire website of documentation with a single command.
net的一个文档生成器，它不复杂，不方便，也不容易使用。给定一个程序集和由Visual Studio生成的XML，只需一个命令就可以生成整个文档网站。
A third option is NDoc:
第三种选择是NDoc:
NDoc generates class library documentation from .NET assemblies and the XML documentation files generated by the C# compiler (or with an add-on tool for VB.NET).
NDoc从。net程序集生成类库文档，并生成由c#编译器生成的XML文档文件(或使用VB.NET的附加工具)。
NDoc uses pluggable documenters to generate documentation in several different formats, including the MSDN-style HTML Help format (.chm), the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web pages.
NDoc使用可插入的文档器来生成不同格式的文档，包括msdn风格的HTML帮助格式(.chm)、Visual Studio . net帮助格式(HTML帮助2)和MSDN-online样式的web页面。
#3
0
NDoc is also an option. But i would go with sand castle and that was what i did.
NDoc也是一个选择。但我会选择沙堡，我就是这么做的。
#4
0
I have created an Open source project to expose them in WebPages Check @ AutoHelp
我已经创建了一个开放源码项目，以在WebPages Check @ AutoHelp中公开它们。
AutoHelp reads the DLL & XML Doc files, generates help pages and exposes them to the users. AutoHelp uses ASP.NET MVC 5, ASP.NET WebApi, TypeScript, jQuery and Bootstrap to be a modern web app.
AutoHelp读取DLL和XML Doc文件，生成帮助页面并将它们公开给用户。AutoHelp使用ASP。净MVC 5,ASP。NET WebApi、打字稿、jQuery和Bootstrap是一个现代的web应用程序。
#1
5
Check out Sandcastle Help File Builder. This is a GUI tool that makes Sandcastle pretty easy to work with. It will install to a folder in Start Menu->Program Files->Sandcastle Help File Builder.; It's pretty easy to use, but it's not incredibly fast.
查看Sandcastle帮助文件构建器。这是一个GUI工具，使Sandcastle非常容易使用。它将安装到开始菜单中的一个文件夹—>程序文件—>Sandcastle帮助文件构建器;使用起来很简单，但也不是特别快。
Hope that helps!
希望会有帮助!
#2
16
Check out Sandcastle.
查看沙塔。
Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments.
Sandcastle通过反映源程序集和可选地集成XML文档注释生成准确、MSDN风格、全面的文档。
Wikipedia has more information and links to additional projects that integrate with sandcastle.
*有更多的信息和链接到与sandcastle集成的其他项目。
Another option (which appears to be much easier to use) is docu:
另一种选择(似乎更容易使用)是:
A documentation generator for .Net that isn't complicated, awkward, or difficult to use. Given an assembly and the XML that's generated by Visual Studio, docu can produce an entire website of documentation with a single command.
net的一个文档生成器，它不复杂，不方便，也不容易使用。给定一个程序集和由Visual Studio生成的XML，只需一个命令就可以生成整个文档网站。
A third option is NDoc:
第三种选择是NDoc:
NDoc generates class library documentation from .NET assemblies and the XML documentation files generated by the C# compiler (or with an add-on tool for VB.NET).
NDoc从。net程序集生成类库文档，并生成由c#编译器生成的XML文档文件(或使用VB.NET的附加工具)。
NDoc uses pluggable documenters to generate documentation in several different formats, including the MSDN-style HTML Help format (.chm), the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web pages.
NDoc使用可插入的文档器来生成不同格式的文档，包括msdn风格的HTML帮助格式(.chm)、Visual Studio . net帮助格式(HTML帮助2)和MSDN-online样式的web页面。
#3
0
NDoc is also an option. But i would go with sand castle and that was what i did.
NDoc也是一个选择。但我会选择沙堡，我就是这么做的。
#4
0
I have created an Open source project to expose them in WebPages Check @ AutoHelp
我已经创建了一个开放源码项目，以在WebPages Check @ AutoHelp中公开它们。
AutoHelp reads the DLL & XML Doc files, generates help pages and exposes them to the users. AutoHelp uses ASP.NET MVC 5, ASP.NET WebApi, TypeScript, jQuery and Bootstrap to be a modern web app.
AutoHelp读取DLL和XML Doc文件，生成帮助页面并将它们公开给用户。AutoHelp使用ASP。净MVC 5,ASP。NET WebApi、打字稿、jQuery和Bootstrap是一个现代的web应用程序。