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

Question

标题说明了一切 ...

在 Sandcastle Help File Builder 中，我们将NamespaceDoc类添加到每个命名空间以创建命名空间文档。

我们如何使用 DocFX？

Answer 1

我是这样做的：

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

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

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

   这些文件应该有一个 YAML 标头，其 UID 与命名空间的名称相匹配。summary: *content行告诉docfx用这个文件的内容覆盖命名空间的概要。

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

   ---
   uid: My.Groovy.Namespace
   摘要：*content
   ---
   My.Groovy.Namespace 命名空间包含一堆类和接口。

Answer 2

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