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

Question

标题说明了一切 ...

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

我们如何使用 DocFX 做同样的事情？

Answer 1

这是我如何做到的:

在文档项目的根文件夹中，添加一个名为 的文件夹。命名空间 .

更新您的 docfx.json 文件以包含添加到 的标记文件命名空间 文件夹。您需要更新 覆盖 房产在构建 部分。它看起来像这样:

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

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

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

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

---
uid: My.Groovy.Namespace
summary: *content
---
The My.Groovy.Namespace namespace contains a bunch of classes and interfaces.