DocFx：如何抑制有关类型的某些信息（继承、构造函数、程序集等）

Question

我正在使用 DocFx 生成有关 WCF Web 服务的文档。文档的目标受众是 Web 服务的客户。这些客户端显然不能直接访问 .NET 二进制文件。

公共接口和模型及其方法和属性的文档很重要，但还有很多其他信息与客户端无关：

• 工具
• 继承成员
• 集会
• 句法
• 构造函数

明确地说 - 我不想过滤掉某些类型或成员（如这里所述） - 我想过滤掉所有类型的文档的整个部分。

Answer 1

您可以通过覆盖模板来自定义输出。

就我而言，我assembly通过以下操作从课程页面中删除了该部分。

1. 导出默认模板docfx template export default。
2. 复制_exported_templates/default/partials/class.header.tmpl.partial到DOCFX_PROJECT_ROOT/templates/custom/partial.
3. 编辑并从复制的文件中删除装配部分。
4. 在您的build部分中docfx.json，将其编辑template为以下内容

"template": [
      "default",
      "templates/custom"
    ],

您现在可以通过类似docfx docfx.json.

我相信您提到的其他部分可以通过编辑和复制模板目录中的相应文件来删除。