.Net XML注释到API文档中

时间:2008-08-03 22:03:38

标签: visual-studio xslt documentation sandcastle xml-comments

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

另外,我最近尝试过设置沙堡,但它真的让我眼前一亮。要么我在这个过程中遗漏了一些重要的东西,要么就是太过分了。

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

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

  

我尝试了沙堡,但很难设置它。   我真正想到的是更简单的东西。

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

6 个答案:

答案 0 :(得分:9)

您正在寻找Sandcastle

项目页面:Sandcastle Releases

博客:Sandcastle Blog

NDoc Code Documentation Generator for .NET曾经是首选工具,但支持已经停止了。

答案 1 :(得分:5)

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

答案 2 :(得分:5)

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

Welcome to the Sandcastle Help File Builder Project

答案 3 :(得分:4)

我刚刚再次成立了Sandcastle。尝试安装它(2008年5月发布)并搜索SandcastleGui.exe或类似的东西(它在示例文件夹中左右)。

单击Add Assembly并添加Assembly或Assemblies,添加任何.xml文档文件(如果启用该选项,则由编译器生成的文件),然后构建。

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

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

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

答案 4 :(得分:4)

关注this simple 5 step article,你已经完成了很多工作。作为奖励,您可以使用H2Viewer查看Html Help 2.x文件。

答案 5 :(得分:2)

我使用NDoc3