npm 包 typedoc-plugin-exclude-references 使用教程

1. 什么是 typedoc-plugin-exclude-references？

typedoc-plugin-exclude-references 是一个 Typedoc 插件，它可以排除 TypeScript 中没有使用的 import 引用。

2. 安装

使用 npm 安装：

npm i -D typedoc typedoc-plugin-exclude-references

3. 使用

在 typedoc 的配置文件（typedoc.json 或者 typedoc.js）中，加入：

{
  "plugins": ["typedoc-plugin-exclude-references"]
}

4. 示例

假设我们有以下一个 TypeScript 文件：

-- -------------------- ---- -------
------ - --------- - ---- ----------------

------------
  --------- -----------
  --------- -
    ------ ----- -------
  -
--
------ ----- ------------ -
  ----- - --- -----
-

我们用 typedoc 生成文档：

typedoc app.component.ts

这将生成一个文档，其中包含了 @angular/core 这个依赖包的所有内容，包括 Component 类型。

如果我们想要排除 Component 类型，只需要在 typedoc 的配置文件中加入 excludeReferences 选项：

{
  "plugins": ["typedoc-plugin-exclude-references"],
  "excludeReferences": ["@angular/core/src/metadata/directives", "@angular/core/src/linker/view"]
}

这样，我们再次用 typedoc 生成文档，就可以看到 Component 类型已经被排除了。

5. 指导意义

使用 typedoc-plugin-exclude-references 可以让我们在生成文档的时候排除掉一些不必要的依赖，让文档更加简洁易读。

另外，在项目中遵循良好的代码规范，也可以让我们在不断的维护和开发中更加容易地识别和管理代码依赖。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb43cb5cbfe1ea061124e