如何从 aspdotnet Web 项目生成纯 HTML 文档？
我已使用适当的 ms xml 文档标签对所有代码进行了注释。如何为所有带注释的代码生成纯 HTML（或 pdf）文档？我已经下载了 sandcastle，但不知道如何进入下一步。谢谢！
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
我已使用适当的 ms xml 文档标签对所有代码进行了注释。如何为所有带注释的代码生成纯 HTML（或 pdf）文档？我已经下载了 sandcastle，但不知道如何进入下一步。谢谢！
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
接受 或继续使用网站，即表示您同意使用 Cookies 和您的相关数据。
发布评论
评论（2）
你可以看看ndoc
http://ndoc.sourceforge.net/
基本上，在项目的属性中，您需要打开 XML 文档。因此，右键单击您的项目，选择属性，导航到“构建”选项卡并选中“XMLDocumentation”复选框。
这会生成一个 xml 文件（不是 html）。然后，您需要使用 XSLT 样式表转换（或解析）xml 文件。这就是 nDoc 的由来。
You can look at ndoc
http://ndoc.sourceforge.net/
Basically, in your project's properties you need to turn on XML documentation. So right click on your project, choose properties, navigate to the Build tab and check the XMLDocumentation checkbox.
This produces an xml file (not html). You then need to transform (or parse) the xml file using an XSLT stylesheet. That's where nDoc comes it.
Sandcastle（ndoc的后继者）是一个出色的文档工具，但具有讽刺意味的是，轻松有效地使用它的途径却没有详细记录。您应该使用 Sandcastle 帮助文件生成器 (SHFB) 或类似平台，而不是尝试直接访问 Sandcastle。 （想想太阳：有太阳在身边真是太好了，但是如果没有一副强力太阳镜，您就不想直视它:-) 那么问题就变成了如何使用 SHFB？
我 2010 年 9 月的文章 驯服沙堡：记录代码的 .NET 程序员指南详细介绍了您需要执行的操作，并指出了您可能会遇到的许多潜在陷阱。 2010 年 10 月，我跟进了 单页挂图，总结了 SHFB 的 XML 文档注释词典。
根据我对本文的研究，以下是其他有用资源的完整列表：
Sandcastle (the successor to ndoc) is an excellent documentation tool but ironically the path to using it easily and effectively is not well-documented. You should use the Sandcastle Help File Builder (SHFB) or similar platform rather than attempting to access Sandcastle directly. (Think of the sun: it is great to have around, but you do not want to look directly at it without some strong sunglasses :-) The question then becomes how to use SHFB?
My September 2010 article Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code details what you need to do, and points out a lot of the potential pitfalls you are likely to encounter. In October 2010 I followed that up with a one-page wall chart that summarizes the XML documentation comment lexicon for SHFB.
From my research for the article, here is a complete list of other useful resources: