npm包typedoc-plugin-external-module-name使用教程

在前端开发中，文档生成是很重要的一项工作，而TypeDoc则是一个非常好用的文档生成工具。TypeDoc默认会将每个模块名称都展示在文档中，但这样可能会让文档变得冗长并且排版不佳。为了解决这个问题，我们可以使用npm包typedoc-plugin-external-module-name来优化文档的呈现。

安装和配置

1. 首先，在项目中安装typedoc-plugin-external-module-name：

   npm install typedoc-plugin-external-module-name --save-dev

2. 然后，在TypeDoc配置文件typedoc.json中添加以下内容：

   {
     "plugins": ["typedoc-plugin-external-module-name"],
     "external-module-name": {
       "moduleName": "@example/module",
       "outputDir": "docs/api"
     }
   }

   在这个配置中，我们指定了要使用的插件和外部模块的名称和输出目录。其中，moduleName是你要隐藏的模块的名称，例如@example/module，outputDir则是生成文档的目录。

使用方法

在你的代码中，当你想要隐藏某个模块时，只需要在导出该模块的位置加上注释即可：

/**
 * @module myModule
 * @internal
 */
export class MyClass {
  // ...
}

在这个例子中，我们使用了@module注释来定义模块名称，并在后面添加了@internal注释来指示该模块不应该在文档中显示。

示例代码

以下是示例代码，其中包含一个名为myModule的模块和一个名为MyClass的类，我们将隐藏该模块以优化文档呈现：

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

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

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

总结

使用npm包typedoc-plugin-external-module-name可以帮助我们优化TypeDoc生成的文档。通过该插件，我们可以轻松地隐藏一些不必要的模块名称，使得文档更加易读和美观。

Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/54844