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

Question

标题说明了一切 ...

在Sandcastle帮助文件生成器中，我们将NamespaceDoc类添加到每个名称空间中以创建名称空间文档。

我们如何使用DocFX进行相同的处理？

Answer 1

这是我的操作方式：

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

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

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

   这些文件应具有YAML标头，其UID与名称空间的名称匹配。该摘要：*内容行告诉docfx来覆盖这个文件的内容命名空间的摘要。

   页面的其余部分是标准markdown，将成为名称空间的摘要。例如：

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

Answer 2

没有办法直接在源代码中添加它。您可以使用覆盖文件来添加命名空间类型的摘要。