如何在DocFX中添加.NET命名空间信息

Question

标题说明了一切......

在Sandcastle帮助文件构建器中，我们为每个命名空间添加了NamespaceDoc类，以创建命名空间文档。

我们如何使用DocFX进行相同的操作？

Answer 1

我是这样做的：

1. 在文档项目的根文件夹中，添加名为命名空间的文件夹。
2. 更新 docfx.json 文件，以包含添加到命名空间文件夹的标记文件。您需要更新构建部分中的覆盖属性。它看起来像这样：

    "overwrite": [
      {
        "files": [
          "apidoc/**.md",
          "namespaces/**.md"
        ],
        "exclude": [
          "obj/**",
          "_site/**"
        ]
      }
    ],

1. 在命名空间文件夹中为要添加文档的每个命名空间创建一个markdown文件。最好将这些文件命名为与命名空间相同的名称。

   文件应该有一个YAML标头，其UID与命名空间的名称相匹配。 摘要：*内容行告诉docfx 使用此文件的内容覆盖命名空间摘要。

   页面的其余部分是标准降价，它将成为命名空间的摘要。例如：

     

   ---
     uid：My.Groovy.Namespace
     摘要：*内容
     ---
     My.Groovy.Namespace命名空间包含许多类和接口。

Answer 2

没有办法直接在源代码中添加它。您可以使用overwrite files添加名称空间类型的摘要。