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

Question

我正在寻求一个好的工具，可以从我的VS2010 XML文档创建HTML / Help文件。我已经找到了一些商业工具，比如：

• .Net文档工具
• VSDocman

我相信还有更多的工具，我只是举这两个作为例子。此外，还有一些简单的XSLT样式表可用于将XML转换为HTML文档。

你在使用什么工具，例如是否有免费的工具来进行转换，可能是作为Add-In的形式。 只是想澄清一下，基本上我找到了两种类型的工具：

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/

为了生成 MsHelp2，我必须安装包含 hscomp.exe 的 VS 2008 SDK。据我所知，有版本1.0和1.1，其中版本1.0包含编译器。请参见Helixsoft和Social MSDN获取一些详细信息。

在我的情况下，生成的WebHelp与Chrome浏览器不兼容。它总是重新加载index.html页面。

此处的主题显示如何在sandcastle文档中添加命名空间信息。

截至2012年11月的更新：对于较小的项目，我正在使用Doxygen - 我发现它更容易配置。

- Horst Walter

---

可能是如何将C# Xml Doc-Comments转换为有用的内容？的重复问题。 - jgauffin

是的，出于某些原因我没有看到这个。一旦我检查了一些工具，我会更新这个。 - Horst Walter

我可以将NuDoc添加到可用的API列表中以读取XML文档吗？http://kzu.to/nudoc - kzu

Answer 1

我们正在使用Sandcastle进行转换，使用Sandcastle Help File Builder作为用户界面来管理帮助项目。在我看来，Sandcastle和SHFB的优点在于，除了“平均”源代码文档之外，您还可以添加其他信息，例如程序的架构、必须遵循的模式或与您的项目不直接相关的任何其他概念内容。通过使用Microsoft Authoring Schema创建附加的xml文件即可实现此功能（可使用Visual Studio编辑该文件和其模式）。使用这两个工具创建类似于MSDN文档非常容易。

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

- jb_

Answer 2

还有两个免费的工具可以从Xml注释中创建文档：

• NDoc
• Sandcastle

- Tim Lloyd

---

据我所知，NDoc 对 .NET 2 或更高版本的支持不是很好。例如泛型的文档等。 - codeulike

还有一个原始的简单 API，可以读取文档成员并通过实现一个简单的访问者自己生成一些内容：NuDoc http://kzu.to/nudoc - kzu

Answer 3

Sandcastle和SHFB是一个很棒的组合。它们是免费的，可以生成html、chm等格式的文档。

- KristoferA