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

Question

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

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

• 实现
• 继承的成员
• 组装
• 语法
• 构造函数

要清楚-我不想过滤掉某些类型或成员（如here所述）-我想过滤掉所有类型的文档的整个部分。

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的{​​{1}}部分中，将docfx.json编辑为以下内容

template

您现在可以使用"template": [ "default", "templates/custom" ], 之类的东西正常构建。

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

Answer 2

如何隐藏继承的成员：

添加

.inheritedMembers { display: none; }

到“_site\styles\main.css”