我已经用适当的 ms xml 文档标签注释了所有代码。如何为所有注释代码生成纯 HTML(或 pdf)文档?我已经下载了沙堡,但不知道如何进行下一步。谢谢!
问问题
269 次
2 回答
5
你可以看看ndoc http://ndoc.sourceforge.net/
基本上,您需要在项目的属性中打开 XML 文档。因此,右键单击您的项目,选择属性,导航到 Build 选项卡并选中 XMLDocumentation 复选框。
这会生成一个 xml 文件(不是 html)。然后,您需要使用 XSLT 样式表转换(或解析)xml 文件。这就是 nDoc 出现的地方。
于 2011-03-07T07:53:59.210 回答
2
Sandcastle ( ndoc的继任者)是一个出色的文档工具,但具有讽刺意味的是,轻松有效地使用它的路径并没有很好的文档记录。您应该使用Sandcastle Help File Builder (SHFB)或类似平台,而不是尝试直接访问 Sandcastle。(想想太阳:有太阳很好,但你不想在没有太阳镜的情况下直视它 :-) 那么问题就变成了如何使用 SHFB?
我在 2010 年 9 月发表的文章Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code详细介绍了您需要做什么,并指出了您可能遇到的许多潜在陷阱。2010 年 10 月,我用一页挂图总结了 SHFB 的 XML 文档注释词典。
根据我对本文的研究,以下是其他有用资源的完整列表:
- Eric Woodruff 的Sandcastle 帮助文件生成器文档(SHFB Creator)
- C# 编程指南:文档注释的推荐标记(MSDN)
- 米。Eric Brunsen 的XML 文档评论指南(Dynicity)
- Anson Horton在 C# 中的 XML 文档(Microsoft C# 编译器程序管理器)
于 2011-03-07T17:03:28.757 回答