什么是 atomdoc
atomdoc 是一个 npm 包，它可以为页面中的代码自动生成文档。
它采用 Atom 的 JSDoc 工具 来解析 JavaScript 代码，从中提取出文档注释，并生成最终的文档输出。
安装 atomdoc
使用 npm 安装 atomdoc，可以通过以下命令完成安装：
npm install -g atomdoc
-g 表示全局安装，可以在任何地方使用 atomdoc 命令。
使用 atomdoc
生成文档
使用 atomdoc 生成文档十分简单，只需要在你的代码中添加注释即可。
注释格式应该遵循 JSDoc 标准。例如，一个常规的 JSDoc 注释如下所示：
-- -------------------- ---- ------- --- - ---- --- ------- --------- - - ------ -------- - --- ----- ------- - ------ -------- - --- ------ ------- - -------- -------- --- --- -- - --- -- -- -------- ------ -- - ------ - - -- -
如果你还不熟悉 JSDoc，可以参考这篇文章。
配置 atomdoc
atomdoc 支持多种配置项，可以通过以下命令来查看当前的配置：
atomdoc config
在命令行中显示的配置项类似于这样：
-- -------------------- ---- -------
-
--------- ------
--------- -------
----------- ----------
--------- -----
-------------- -------
--------- -
------------
-------------
-
-你可以在项目根目录下创建一个 .atomdocrc 文件来覆盖这些默认配置。
.atomdocrc 文件应该长这样：
-- -------------------- ---- -------
-
--------- -----
--------- ----------------
----------- ---------
--------- ------
-------------- -----
--------- -
------------
-------------
-
-此配置将为文档源码目录设置为 js，文档输出目录设置为 documentation，使用自定义文档模板 custom，不公开生成的文档，生成的索引文件为 Markdown 格式。忽略所有 test/ 目录下的文件，以及所有后缀名为 .min.js 的文件。
示例代码
以下是一个路径拼接的示例代码，使用 atomdoc 来生成文档：
-- -------------------- ---- ------- --- - ----- - ---- ---- ---- - --------- ----- - - ------ -------- --- --- --------- ----- - ------ -------- ---- --- ---- ----- - -------- -------- --- ---- ---- ----- -- -------- -------------- ----- - ------ --- - --- - ----- -
添加注释后，运行 atomdoc 命令即可生成文档：
atomdoc generate
这可能会在当前目录下生成一个名为 docs 的文件夹，其中包含路径拼接方法的文档页。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/73866