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

Question

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

docfx

6

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

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

- Implements - Inherited Members - Assembly - Syntax - Constructors

需要明确的是 - 我不想过滤掉某些类型或成员（如此处所述） - 我想过滤掉所有类型文档中的整个部分。

- Laurence

2个回答

2

如何隐藏继承的成员：

添加

.inheritedMembers { display: none; }

to "_site\styles\main.css"

- Денис Болотин

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- kota · Accepted Answer

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

在我的情况下，我通过以下步骤从类页面中删除了assembly部分：

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

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

现在你可以通过类似 docfx docfx.json 的方式来正常构建。

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