typedoc-plugin-internal-external 是一个 npm 包，它可以让你在生成 TypeScript API 文档时，轻松地将内部和外部链接标记为不同类型的链接。
如果你正在开发 TypeScript 库，并且使用 typedoc 生成 API 文档，那么这个插件会非常有用。
安装
首先，你需要在项目中安装 typedoc。
npm install -g typedoc
然后，安装 typedoc-plugin-internal-external：
npm install --save-dev typedoc-plugin-internal-external
使用
在你的 typedoc 配置文件中，添加 typedoc-plugin-internal-external：
{
"plugin": [
"typedoc-plugin-internal-external"
]
}现在，你可以在代码中使用特殊的注释来标记内部和外部链接。
内部链接
内部链接指向你库中的其他类、接口、枚举等。使用 [[ 和 ]] 将链接包围。
-- -------------------- ---- ------- --- - ---------- - ----- - - -------- - ---- --------- -- -------- -- --- -------- - - --------- -- ------ --------- ---- - --- - --- ------ ---------- -- --- ----- -- --- ------- --- - --- ---- -- --- ----- -- ----- ------- --- - --- ----- ------- -- --- ----- -- ------ ------- - --- - ---------- - ----- -- ------ - - -------- - ---- ----- -- -------- -- --- -------- - - --------- -- ------ ----- --------- - --- - --- ----- -- --- ------ -- ------ ------- -
在上面的例子中，我们使用 @internal 标记了这两个成员是库内部使用的，并使用内部链接将它们链接在一起。
外部链接
外部链接指向你库以外的其他库或文档。使用 < 和 > 将链接包围。
-- -------------------- ---- ------- --- - -------- - ---- -------- ----- --- -- --- --------------------------------- -------- - - ------ --- - --- --- -- -------- - - -------- --- ---- -------- ---- --- ------- -- ------ ----- -------- ---------------- -------- ------------ - ----- -------- - ----- --------------- ------ -------------- -
在上面的例子中，我们使用外部链接将 axios 库链接到了我们的文档中。
示例代码
-- -------------------- ---- ------- --- - ---------- - ----- - - -------- - ---- --------- -- -------- -- --- -------- - - --------- -- ------ --------- ---- - --- - --- ------ ---------- -- --- ----- -- --- ------- --- - --- ---- -- --- ----- -- ----- ------- --- - --- ----- ------- -- --- ----- -- ------ ------- - --- - ---------- - ----- -- ------ - - -------- - ---- ----- -- -------- -- --- -------- - - --------- -- ------ ----- --------- - --- - --- ----- -- --- ------ -- ------ ------- - --- - -------- - ---- -------- ----- --- -- --- --------------------------------- -------- - - ------ --- - --- --- -- -------- - - -------- --- ---- -------- ---- --- ------- -- ------ ----- -------- ---------------- -------- ------------ - ----- -------- - ----- --------------- ------ -------------- -
总结
typedoc-plugin-internal-external 是一个非常有用的 npm 包，可以帮助你生成更好的 TypeScript API 文档。在你的库中使用内部和外部链接，可以帮助其他开发者更好地理解你的代码。
从本文中，你学习了如何安装和使用 typedoc-plugin-internal-external。现在，你可以开始在你的 TypeScript 库中使用内部和外部链接，生成更好的 API 文档了。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/186215