如何从aspdotnet Web项目生成纯HTML文档?

时间:2011-03-07 07:49:18

标签: c# .net documentation-generation sandcastle

我已使用相应的ms xml文档标记对所有代码进行了评论。如何为所有注释代码生成仅HTML(或pdf)文档?我已经下载了sandcastle,但无法弄清楚如何进入下一步。谢谢!

2 个答案:

答案 0 :(得分:5)

你可以看看ndoc http://ndoc.sourceforge.net/

基本上,在项目的属性中,您需要打开XML文档。因此,右键单击您的项目,选择属性,导航到Build选项卡并检查XMLDocumentation复选框。

这会生成一个xml文件(不是html)。然后,您需要使用XSLT样式表转换(或解析)xml文件。这就是nDoc的用武之地。

答案 1 :(得分: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月,我用one-page wall chart跟进了它,总结了SHFB的XML文档评论词典。

根据我对该文章的研究,以下是其他有用资源的完整列表: