在前端开发中，有时我们需要使用 TypeScript 来编写代码，同时也需要使用 TypeDoc 来生成文档。然而，在使用 TypeDoc 生成文档时，如果父类中的某个方法被子类重写，TypeDoc 会将子类中的文档中的该方法也标注为 “inherited from base class”，可能会导致文档的可读性下降。因此，有人为此开发了名为 typedoc-plugin-no-inherit 的 npm 包，来解决这个问题。
在本文章中，我们将介绍如何使用 typedoc-plugin-no-inherit 包来生成更好的文档，具体内容包括：
- typedoc-plugin-no-inherit 包的基本介绍；
- typedoc-plugin-no-inherit 包的安装和使用方法；
- typedoc-plugin-no-inherit 包的注意事项。
1. typedoc-plugin-no-inherit 包的基本介绍
typedoc-plugin-no-inherit 包是一个可以在使用 TypeDoc 生成文档时，去除子类中被重写的方法所标注的 “inherited from base class” 的 npm 包。通过使用 typedoc-plugin-no-inherit 包，我们可以生成更加易读的文档。
2. typedoc-plugin-no-inherit 包的安装和使用方法
首先，我们需要在项目中安装 typedoc-plugin-no-inherit 包。可以通过执行以下命令来完成安装：
npm install typedoc-plugin-no-inherit --save-dev
接下来，在执行 TypeDoc 命令时，加入 --plugin typedoc-plugin-no-inherit 参数即可。例如：
./node_modules/.bin/typedoc --out ./docs ./src --plugin typedoc-plugin-no-inherit
需要注意的是，命令中的参数 ./src 是需要生成文档的 TypeScript 代码所在的文件夹路径，./docs 是生成的文档存放的文件夹路径。
3. typedoc-plugin-no-inherit 包的注意事项
在使用 typedoc-plugin-no-inherit 包时，有一些需要注意的事项：
- typedoc-plugin-no-inherit 只对文档中的方法标注进行了修改，属性标注不受影响；
- typedoc-plugin-no-inherit 包目前只支持 TypeScript 3.x；
- typedoc-plugin-no-inherit 包不支持通过 interface 实现继承。
示例代码
以下是一个 TypeScript 代码示例：
-- -------------------- ---- -------
----- ------ -
---
- -------
-
- ------ --- ----
--
------ ------------ ------- -
-------------------------
-
-
----- --- ------- ------ -
---
- ------
--
------ --------- -
-------------------
--------------------
-
-使用 TypeDoc 自动生成文档后，呼吸方法文档中会标注“inherited from base class”，使用 typedoc-plugin-no-inherit 包后，文档中的呼吸方法将不再带有 “inherited from base class” 标注。
结语
在编写 TypeScript 代码后，使用 TypeDoc 来生成文档是一种非常实用的方法。通过使用 typedoc-plugin-no-inherit 包，我们可以更好地为我们的代码生成文档，提高文档的可读性。希望这篇文章能够帮助大家更好地了解和使用 typedoc-plugin-no-inherit 包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb472b5cbfe1ea061129d