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

Question

我正在使用Visual Studio 2010并开始成为一个好孩子,并在我编写它时通过XML注释记录我的所有代码.我有一个记录良好的项目,我甚至想出了如何使Visual Studio在进行构建时吐出一个完整的XML文档.我的问题是,在网络上格式化/显示此文档的最佳方式是什么,以便它以友好和可用的格式出现,如MSDN？有没有一种工具能够轻松完成这项工作？

提前致谢!

Answer 1

看看沙堡吧.

Sandcastle通过反映源程序集并可选地集成XML文档注释,生成准确的MSDN样式,全面的文档.

维基百科有更多信息和链接到与沙堡集成的其他项目.

另一种选择(看起来更容易使用)是纪录片:

.Net的文档生成器,不复杂,难以使用或难以使用.给定一个程序集和由Visual Studio生成的XML,document可以使用单个命令生成整个文档网站.

第三个选项是NDoc:

NDoc从.NET程序集和C#编译器生成的XML文档文件(或使用VB.NET的附加工具)生成类库文档.

NDoc使用可插入的文档来生成多种不同格式的文档,包括MSDN样式的HTML帮助格式(.chm),Visual Studio .NET帮助格式(HTML Help 2)和MSDN在线样式的Web页面.

Answer 2

查看Sandcastle帮助文件生成器.这是一个GUI工具,使Sandcastle非常容易使用.它将安装到开始菜单 - >程序文件 - > Sandcastle帮助文件生成器中的文件夹中.它非常易于使用,但速度并不快.

希望有所帮助!