26

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

我相信还有更多，我只是列出这两个作为示例。还有一些简单的 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. 有一个版本 1.0 和 1.1，据我所知，版本 1.0 包含编译器。有关详细信息，请参阅Helixsoft和Social MSDN。
  5. 在我的情况下，生成的 WebHelp 无法与 Chrome 一起正常工作。它总是重新加载 index.html 页面。
  6. 这里的主题展示了如何将命名空间信息添加到沙堡文档中。
  7. 2012 年 11 月更新：对于较小的项目，我使用Doxygen - 我发现它更容易配置。
4

3 回答 3

19

我们使用 Sandcastle 进行转换和 Sandcastle Help File Builder 作为用户界面来管理帮助项目。在我看来，Sandcastle 和 SHFB 的美妙之处在于，除了“普通”源代码文档之外，您还可以添加其他信息，例如程序架构、必须遵循的模式或项目的任何其他概念内容直接到你程序中的一堂课。这可以通过在 Microsoft Authoring Schema 的帮助下创建额外的 xml 文件来完成（可以使用 Visual Studio 编辑，因为 xml 文件和它的架构可用）。从这两个工具开始创建类似 MSDN 的文档非常容易。

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

于 2011-01-24T12:17:53.603 回答
3

另外两个允许从 Xml 注释创建文档的免费工具：

于 2011-01-24T12:13:25.227 回答
3

Sandcastle + SHFB 是一个很棒的组合。免费并生成html、chm等

于 2011-01-24T12:15:55.633 回答