.Net XML 注释到 API 文档中

Question

是否有一种简单的方法可以从 Visual Studio XML 输出生成 MSDN 样式的文档？
我没有足够的耐心为它设置一个好的 xslt，因为我知道我不是第一个跨过这座桥的人。

另外，我最近尝试设置sandcastle，但它确实让我的眼睛交叉。 要么是我在这个过程中遗漏了一些重要的东西，要么就是太牵强了。

我知道有人有一个非常好的死简单的解决方案。

我在这里重申，因为我认为我的格式使该段落不吸引人阅读：

我尝试了 Sandcastle，但设置起来非常困难。 我真正想到的是简单得多的事情。

也就是说，除非我只是不了解沙堡过程。 对我来说，仅仅为测试人员制作一些不错的东西就好像有很多额外的负担。

Answer 1

你在找沙堡

项目页面：沙堡发布

博客：沙堡博客

用于 .NET 的 NDoc 代码文档生成器曾经是首选工具，但支持几乎停止了。

Answer 2

您还应该使用 Sandcastle 帮助文件生成器。 它为您提供了类似 ndoc 的 GUI 来生成帮助文件，因此您无需在命令提示符下执行任何操作。

欢迎使用 Sandcastle 帮助文件生成器项目

Answer 3

看看Sandcastle ，它就是这样做的。 它也是更简单的解决方案之一，它或多或少是首选工具，所以从长远来看，如果您指定在设置过程中遇到的问题，也许我们可以帮助您设置 Sandcastle？

Answer 4

我刚刚重新设置了 Sandcastle。 尝试安装它（2008 年 5 月的版本）并搜索 SandcastleGui.exe 或类似的东西（它在示例文件夹左右）。

单击添加程序集并添加您的程序集或程序集，添加任何 .xml 文档文件（如果启用了该选项，则由编译器生成的文件）然后构建。

这将需要一些时间，但结果将是值得的。 它实际上会从 MSDN 中查找内容，因此您生成的文档还将具有一直到 System.Object 的类继承以及指向 MSDN 和其他内容的链接。

Sandcastle 一开始看起来有点复杂，特别是当你想在自动构建中使用它时，但我绝对相信它是值得的。

另请查看Sandcastle Help File Builder ，这是一个更高级的 GUI。

Answer 5

遵循这篇简单的 5 步文章，您就大功告成了。 作为奖励，您可以使用H2Viewer查看 Html 帮助 2.x 文件。

Answer 6

我使用NDoc3