介绍
doxdox 是一个用来生成文件解构文档的 npm 包,支持针对 JavaScript、TypeScript、CoffeeScript 这些主流语言的注释解析。
安装
使用 npm 进行安装:
--- ------- -- ------
使用
在终端中执行以下命令:
------ ---------
其中 options 可以是下列命令:
命令 | 描述 |
---|---|
-i, --input | 指定要生成文档的文件夹的路径,默认是当前文件夹。 |
-o, --output | 指定生成的文档的输出目录,默认是当前文件夹中的 doc 文件夹。 |
-t, --template | 指定模板文件路径,默认模板文件是 node_modules/doxdox/template.md。 |
-n, --name | 指定输出文档的标题,默认是 "API Documentation"。 |
执行命令后,doxdox 将会解析指定文件夹中的文件并为其生成文档。
示例
以下是一个例子,解析了当前目录下的 index.js
文件,并将生成文件的标题改为 "My API Documentation":
------ -- -- -- --- --- --------------
注意事项
- 在 JavaScript 文件中,doxdox 支持以下格式的注释:
--- - ----- -- -- - ----- -- --- --- ----- --- -- -----
- 在 TypeScript 文件中,doxdox 支持以下格式的注释:
--- - ----- -- -- - ----- -- --- --- ----- --- -- ----- -- ----
- 在 CoffeeScript 文件中,可使用 dox 来生成注释,然后使用 doxdox 来解析。
结论
使用 doxdox 可以方便地为文件夹中的文件自动生成文档,让开发者可以很方便地查阅代码库中的结构和说明,缩短学习时间和找到所需信息的时间。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/65821