c# - 如何格式化 Visual Studio XML 文档以在 Web 上显示

Question

我正在使用 Visual Studio 2010，并且开始做一个好 child ，并在编写代码时通过 XML 注释记录我的所有代码。我有一个文档齐全的项目，我什至想出了如何让 Visual Studio 在进行构建时吐出一个完整的 XML 文档。我的问题是，在 Web 上格式化/显示此文档的最佳方式是什么，以便它以像 MSDN 这样友好且可用的格式显示？有没有一种工具可以轻松做到这一点？

提前致谢!

Answer 1

查看 Sandcastle .

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments.

Wikipedia有更多信息和指向与沙堡集成的其他项目的链接。

---

另一个选项(似乎更容易使用)是 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.

---

第三个选项是 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 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.