在前端开发过程中，我们经常需要对代码进行文档化处理。而 JSDoc 就是一个非常好的前端文档生成工具。若想更加方便快捷地使用 JSDoc，可以使用 npm 包 Urbanjs-tool-jsdoc。
Urbanjs-tool-jsdoc 简介
Urbanjs-tool-jsdoc 是一个 JSDoc 命令行工具，用于生成 JavaScript 源码文档。这个工具可以可以生成各种格式的文档，比如 HTML、JSON、Markdown、LaTex 和 XML等。而且，其支持多种插件和自定义扩展，可以实现自定义文档输出样式和格式。
Urbanjs-tool-jsdoc 安装
使用 npm 命令，可以非常快速地进行安装。
--- ------- -------- ------------------
安装好之后，即可使用 urbanjs-doc 命令，进行文档生成。
Urbanjs-tool-jsdoc 使用
Urbanjs-tool-jsdoc 需要通过配置文件和命令行参数，来生成文档文件。
下面是一个配置文件示例（jsdoc.json）：
-
--------- -
---------- --------
---------- --
--
---------- -
------------------
--
------- -
----------- -------
-------------- -------
---------- -----
----------- ----------------------
--
----------- -
--------- ------
----------- ----
--
------------ -
-------------- ------
----------------- ------
---------- -
-------------------- ----
-
-
-- "source":
- "include" 属性：指定要进行文档化处理的源文件目录。
- "exclude" 属性：指定要忽略的文件或目录。
- "plugins": 插件列表。
- "opts":
- "encoding" 属性：生成文档文件的编码格式。
- "destination" 属性：文档输出目录。
- "recurse" 属性：是否递归处理文件目录。
- "template" 属性：文档输出的模板。
- "markdown": Markdown 格式的配置项。
- "templates": 模板配置项。
生成文档的命令如下：
----------- -- ----------
执行完毕之后，即可在设置的 destination 目录中看到生成的文档文件。
示例：
以下示例展示了一个简单的人类类（Human）的 JSDoc 文档：
--- - ----- -------- - - ------ - ------ -------- ---- - ----- - ------ -------- --- - ----- - -------- - -- ---- ----- -- - --- --- - --- ------------ ---- -- --- ----- - -------------- ---- - --- - ----- - ----- -------- -- --------- - ----- --- - ----- - ----- -------- -- -------- - ---- -- --- - ----- - ------- - ------ -------- ---- - ----- -- -------------------- - -------------- - --------------------- - - --- - ------ --
运行命令，使用 urbanjs-doc 工具生成文档：
----------- -- ----------
浏览器打开生成的 html 文件，可以看到如下文档：
如上图所示，我们不仅可以看到这个类的基本信息，而且还可以看到实例属性和实例方法的详细说明。
总结
Urbanjs-tool-jsdoc 工具可以帮助我们更加方便地生成前端文档。本文简单介绍了其安装和使用方式，并提供了一个代码示例。希望能对大家有所帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600562c981e8991b448e00e7