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

【问题标题】：How can I add .NET namespace information in DocFX如何在 DocFX 中添加 .NET 命名空间信息
【发布时间】：2018-01-04 00:09:39
【问题描述】：

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

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

我们如何使用 DocFX？

【问题讨论】：

标签： docfx

【解决方案1】：

我是这样做的：

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

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

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

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

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

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

【讨论】：

【解决方案2】：

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

【讨论】：