代码之家  ›  专栏  ›  技术社区  ›  MojoFilter

API文档中的.NET XML注释

  •  15
  • MojoFilter  · 技术社区  · 16 年前

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

    另外,我最近也试过建沙堡,但它真的让我大吃一惊。要么我在这个过程中遗漏了一些重要的东西,要么就是太牵扯其中了。

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

    我在这里重申,因为我认为我的格式设置使该段落不受邀请阅读:

    我试了一下Sandcastle,但很难把它安装好。 我真正想到的是更简单的事情。

    也就是说,除非我不明白沙堡的过程。对于我来说,仅仅为了让测试人员能够使用一些好的东西,这似乎是一个非常多的额外负担。

    6 回复  |  直到 11 年前
        1
  •  9
  •   Karl Seguin    12 年前

    你在找沙堡

    项目页面: Sandcastle Releases

    博客: Sandcastle Blog

    NDoc Code Documentation Generator for .NET 以前是可以选择的工具,但是支持几乎停止了。

        2
  •  5
  •   Michael Stum    16 年前

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

        3
  •  5
  •   AaronS    12 年前

    您还应该使用sandcastle帮助文件生成器。它为您提供了一个类似于ndoc的GUI来生成帮助文件,这样您就不必在命令提示符下做任何事情。

    Welcome to the Sandcastle Help File Builder Project

        4
  •  4
  •   huseyint    16 年前

    跟随 this simple 5 step article 你已经完成了很多。作为奖励,您可以使用 H2Viewer 查看HTML帮助2.x文件。

        5
  •  4
  •   Andrew Barber Eric Lafortune    12 年前

    我刚刚又建了沙堡。尝试安装它(2008年5月的版本),然后搜索sandcastlegui.exe或类似的文件(它在examples文件夹中)。

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

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

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

    也可以看看 Sandcastle Help File Builder ,这是一个更高级的图形用户界面。

        6
  •  2
  •   Muxa    15 年前

    我用 NDoc3

    推荐文章