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

Question

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

• .Net documentation tool
• VSDocman

我肯定还有更多，我只是举这两个作为例子。还有一些简单的 XSLT 样式表可以将 XML 转换为 HTML 文档。

你在用什么，例如是否有免费的工具来进行转换，也许作为加载项。澄清一下，基本上我找到了两种类型的工具:

1. 将 XML 文档文件转换为不同的目标格式，这就是我要找的。
2. 帮助我在源代码中生成 XML 文档的工具。这不是(!)我要找的。

感谢您的帮助。

---

SandcaSTLe/SHFB 组合效果很好。感谢所有提供帮助的人。

一些说明:

1. NDoc 似乎已经过时了，最后一次更新是在 2005 年。这就是我跳过这个的原因。
2. 可以在此处找到类似的线程，也非常详细:https://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something-useful感谢提示!
3. SandcaSTLe 有一些资源，我找到的最新版本位于:http://sandcastle.codeplex.com/
4. 为了生成MsHelp2，我必须安装包含hscomp.exe 的VS 2008 SDK。有版本 1.0 和 1.1，据我所知，版本 1.0 包含编译器。参见 Helixsoft和 Social MSDN了解一些详情。
5. 在我的例子中，生成的 WebHelp 不能与 Chrome 一起正常工作。它总是重新加载 index.html 页面。
6. topic here展示了如何将命名空间信息添加到 SandcaSTLe 文档中。
7. 截至 2012 年 11 月的更新:对于较小的项目，我使用 Doxygen - 我发现它更容易配置。

Answer 1

我们使用 SandcaSTLe 进行转换，并使用 SandcaSTLe Help File Builder 作为用户界面来管理帮助项目。在我看来，SandcaSTLe 和 SHFB 的美妙之处在于，除了“普通”的源代码文档之外，您还可以添加其他信息，例如程序的体系结构、必须遵循的模式或项目的任何其他未绑定(bind)的概念性内容直接到你程序中的一个类。这可以通过在 Microsoft 创作模式的帮助下创建额外的 xml 文件来完成(可以使用 visual studio 进行编辑，因为 xml 文件和它的模式可用)。使用这两种工具创建类似 MSDN 的文档非常容易。

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