从VS 2010生成HTML /帮助文件C#XML文档

问题描述:

我正在寻找一个很好的工具,可以从我的VS2010 XML文档创建HTML /帮助文件。我已经发现了一些商业工具,如从VS 2010生成HTML /帮助文件C#XML文档

我相信有更多的,我只列出这两个作为例子。还有一些简单的XSLT样式表可以将XML转换为HTML文档。

你在用什么,例如有没有一个免费的工具来做转换,可能是插件。 只是为了澄清,基本上我已经发现两种类型的工具:

  1. 的那些转换在不同的目标格式的XML文档文件,这是我所期待的。
  2. 帮助我在源代码中生成XML文档的工具。这不是(!)我正在寻找的东西。

感谢您的帮助。


沙堡/ SHFB组合工作得很好。感谢所有的帮助。

一些言论:

  1. NDoc的似乎已经过时,最后更新是从2005年开始这就是为什么我跳过了这一点。
  2. 一个类似的线程,也非常详细,可以在这里找到:How to turn C# Xml Doc-Comments into something useful?感谢您的提示!
  3. 有一些来源沙堡,最新的版本,我发现在这里位于:http://sandcastle.codeplex.com/
  4. 为了产生MsHelp2我必须安装含有hscomp.exe VS 2008 SDK。有一个版本1.0和1.1,据我所知,版本1.0包含编译器。有关详细信息,请参见HelixsoftSocial MSDN
  5. 在我的情况下,生成的WebHelp无法正常使用Chrome。它总是重新加载index.html页面。
  6. topic here显示如何将命名空间信息添加到sandcastle文档中。
  7. 更新截至2012年11月:对于我使用的小型项目Doxygen - 我觉得配置起来要容易一些。
+2

可能重复的[如何将C#Xml Doc-Comments变成有用的东西?](http://*.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something - 有用) – jgauffin 2011-01-24 12:25:31

+0

是的,我出于某些原因没有看到这个。一旦我检查了一些工具,我会更新这个。 – 2011-01-24 17:00:50

+1

我可以将NuDoc添加到可用API的列表中以阅读XML文档吗? http://kzu.to/nudoc – kzu 2013-06-11 20:21:11

我们使用Sandcastle进行转换& Sandcastle帮助文件生成器作为用户界面来管理帮助项目。在我看来,Sandcastle和SHFB的美妙之处在于,除了“平均”源代码文档之外,您还可以添加其他信息,例如程序体系结构,必须遵循的模式或者与您的项目不相关的其他概念内容直接在你的程序中的一个类。这可以通过在Microsoft Authoring Schema的帮助下创建附加的xml文件来完成(可以使用visual studio将其编辑为xml文件,并且可以使用它的架构)。使用这两种工具创建MSDN文档非常容易。

很久以前,我尝试了docbook,它在技术方面几乎相同(包含信息和xslt文件的xml文件将其转换为各种输出类型)。但对我们来说,这是没有选择的,因为没有可以使用visual studio生成的xml文档的转换(再加上概念内容的转换对我们来说非常痛苦)。

两个更*的工具,允许从XML注释文档的创建:

沙堡+ SHFB是一个伟大的组合。免费并生成html,chm等