.Net XML 注释到 API 文档中答案

【问题标题】：.Net XML comment into API Documentation.Net XML 注释到 API 文档中
【发布时间】：2010-09-05 06:39:28
【问题描述】：

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

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

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

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

我尝试了 sandcastle，但设置起来非常困难。我真正想到的是更简单的东西。

也就是说，除非我只是不了解沙堡流程。对我来说，为测试人员制作一些好用的东西似乎是一大堆额外的包袱。

【问题讨论】：

【解决方案1】：

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

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

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

Sandcastle 一开始似乎有点复杂，尤其是当您想在自动构建中使用它时，但我绝对相信它是值得的。

还可以查看Sandcastle Help File Builder，这是一个更高级的 GUI。

【讨论】：

【解决方案2】：

你在寻找沙堡

NDoc Code Documentation Generator for .NET 曾经是首选工具，但支持几乎停止。

【讨论】：

【解决方案3】：

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

【讨论】：

【解决方案4】：

我用NDoc3

【讨论】：

【解决方案5】：

关注this simple 5 step article，您就大功告成了。作为奖励，您可以使用H2Viewer 查看 Html Help 2.x 文件。

【讨论】：

【解决方案6】：

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

【讨论】：