简介
typedoc-plugin-example-tag 是一款基于 TypeScript 的文档生成工具 TypeDoc 的插件，可以通过给代码中添加示例标签实现在文档中展示代码示例。
安装
在项目根目录下打开终端，执行以下命令进行安装：
npm install --save-dev typedoc typedoc-plugin-example-tag
配置
在项目根目录下创建一个 typedoc.json 文件，内容如下：
-- -------------------- ---- -------
-
------ -------
---------- ---------------------------------------
---------------------- -----
------------------------- -----
-------------- -
----------------
--
---------- -
-
------- -----------------------------
---------- -
---------- -
-------
--
---------- -
-----------
--
---------------------------- ----
-
-
-
-其中，out 指定了文档生成的输出目录，exclude 指定了排除的文件和文件夹，entryPoints 指定了入口文件，plugins 指定了使用的插件及其选项。
在 TypeScript 代码中，使用 @example 标签来添加示例代码。示例如下：
-- -------------------- ---- ------- --- - ---------- - - -------- - --- - -- --- --------- - ----- ------------- - ----- ------- -- -------------- - -------------------------------- --------- -- ----- ---- ---- ---- ---- - -- ---- ---- ---- ---- ---- - --- -- ------ ----- ------------- - ----- ------- -- --------------
生成文档
在项目根目录下执行以下命令即可生成文档：
npx typedoc
生成的文档将保存在 docs 目录下。
结束语
typedoc-plugin-example-tag 是 TypeDoc 的一款简单易用的插件，可以方便地为 TypeScript 代码生成文档，并且可以在文档中展示代码示例。希望本文能够对大家学习和使用该插件提供一定的帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f1a894c403f2923b035c4a0