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

Question

我正在寻找一个从我的VS2010 XML文档创建HTML /帮助文件的好工具.我找到了一些商业工具,比如

• .Net文档工具
• VSDocman

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

您在使用什么,例如是否有免费工具进行转换,可能是插件.只是为了澄清,基本上我找到了两种工具:

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

谢谢你的帮助.

---

Sandcastle/SHFB组合效果很好.感谢所有帮助过的人.

一些评论:

1. NDoc似乎已经过时,最近的更新是从2005年开始的.这就是我跳过这个的原因.
2. 类似的线程,也非常详细,可以在这里找到:如何将C#Xml Doc-Comments变成有用的东西？谢谢你的暗示!
3. Sandcastle有一些来源,我找到的最新版本位于:http://sandcastle.codeplex.com/
4. 为了生成MsHelp2我不得不安装VS 2008 SDK包含hscomp.exe.有一个版本1.0和1.1,据我所知,版本1.0包含编译器.有关详细信息,请参阅Helixsoft和Social MSDN.
5. 在我的情况下,生成的WebHelp无法与Chrome正常工作.它总是重新加载index.html页面.
6. 此处的主题显示如何将命名空间信息添加到sandcastle文档中.
7. 截至2012年11月的更新:对于我使用Doxygen的小型项目- 我发现它更容易配置.

Answer 1

我们使用Sandcastle进行转换,使用Sandcastle帮助文件生成器作为用户界面来管理帮助项目.在我看来,Sandcastle和SHFB的优点在于,除了"普通"源代码文档之外,您还可以添加其他信息,例如程序的体系结构,必须遵循的模式或任何其他未绑定项目的概念内容直接到你的程序中的一个类.这可以通过在Microsoft Authoring Schema的帮助下创建其他xml文件来完成(可以使用visual studio作为xml文件进行编辑,并且可以使用其架构).它很容易从这两个工具开始创建MSDN文档.

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