.Net XML注释到API文档中

时间:2020-03-05 18:37:26  来源:igfitidea点击:

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

另外,我最近尝试设置沙堡,但确实让我眼前一亮。我可能在此过程中遗漏了一些重要的东西,或者涉及的太多。

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

我在这里重申,是因为我认为自己的格式使该段不宜阅读:

I gave sandcastle a try but had a really hard time getting it set up.
  What I really have in mind is something much simpler.

也就是说,除非我只是不了解沙堡过程。在我看来,这似乎给我带来了很多额外的负担,只是为测试人员提供了一些不错的选择。

解决方案:

我们在寻找沙堡

项目页面:Sandcastle发布

博客:Sandcastle博客

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

看看Sandcastle,它就是这样做的。它也是目前使用的更简单的## 解决方案之一,或者多或者少是选择的工具,因此从长远来看,如果我们指定在安装过程中遇到什么问题,也许我们可以设置Sandcastle?

我刚刚再次设置了沙堡。尝试安装它(2008年5月版)并搜索SandcastleGui.exe或者类似的文件(在examples文件夹中)。

单击添加程序集并添加一个或者多个程序集,添加任何.xml文档文件(如果启用了该选项,则由编译器生成的文件),然后生成。

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

起初,Sandcastle似乎有点复杂,尤其是当我们想在自动构建中使用它时,但我绝对相信这是值得的。

还可以查看Sandcastle帮助文件生成器,这是它的一种更高级的GUI。

跟随这篇简单的5步文章,我们已经完成了许多工作。另外,我们可以使用H2Viewer来查看HTML Help 2.x文件。

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

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

我使用NDoc3