.Net XML注释到API文档中

Question

有没有一种从Visual Studio XML输出生成MSDN样式文档的简单方法？
我没有耐心为它建立一个好的xslt,因为我知道我不是第一个跨过这座桥的人.

此外,我最近尝试设置沙堡,但它真的让我的眼睛交叉.要么我错过了一些重要的过程,要么就是太过牵扯.

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

我在这里重申,因为我认为我的格式化使该段非邀请阅读:

我尝试了一下沙堡,但很难设置它.我真正想到的是更简单的事情.

也就是说,除非我不理解沙堡过程.对我来说,为了给测试人员提供一些好的东西,这似乎是一件非常多的额外包袱.

Answer 1

你在找Sandcastle

项目页面:Sandcastle发布

博客:Sandcastle博客

用于.NET的NDoc代码文档生成器曾经是首选工具,但支持已停止.

Answer 2

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

Answer 3

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

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

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

Sandcastle 乍一看似乎有点复杂，尤其是当您想在自动化构建中使用它时，但我绝对相信它值得付出努力。

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

Answer 4

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

欢迎来到Sandcastle帮助文件生成器项目