简介
doxx 是一个用于生成文档的命令行工具，可以将注释转换为美观易读的 HTML 格式文档。使用 doxx 可以方便地为项目生成 API 文档或者其他类型的文档。
安装
使用 npm 安装 doxx：
npm install -g doxx
安装完成后，在命令行中输入 doxx 即可查看 doxx 的帮助信息。
使用方法
1. 配置文件
doxx 支持通过配置文件进行文档生成。在项目根目录下创建 doxx.json 文件，写入以下内容：
{
"input": "./src",
"output": "./docs",
"title": "My Project Documentation"
}input: 源代码目录，doxx 将会扫描该目录下的所有文件，提取注释并生成文档。output: 文档输出目录。title: 文档标题。
2. 注释格式
doxx 使用 JSDoc 风格的注释来生成文档。例如：
-- -------------------- ---- ------- --- - ------- - ------ -------- - ---- - ------ -------- - ---- - -------- -------- ----- -- -------- ------ -- - ------ - - -- -
其中，@param 表示函数参数，@returns 表示函数返回值。
3. 生成文档
在命令行中进入项目根目录，并执行以下命令：
doxx --config doxx.json
此时，doxx 将会扫描 ./src 目录下的所有文件，并将生成的文档输出到 ./docs 目录。
示例代码
以下是一个简单的示例，演示了如何使用 doxx 生成 API 文档：
-- -------------------- ---- ------- --- - ------- - ------ -------- - ---- - ------ -------- - ---- - -------- -------- ----- -- -------- ------ -- - ------ - - -- - --- - ------- - ------ -------- - --- - ------ -------- - -- - -------- -------- ----- -- -------- ----------- -- - ------ - - -- -
创建 doxx.json 文件，写入以下内容：
{
"input": "./src",
"output": "./docs",
"title": "API Documentation"
}在命令行中执行以下命令：
doxx --config doxx.json
此时，doxx 将会扫描 ./src 目录下的所有文件，并将生成的文档输出到 ./docs 目录。打开 ./docs/index.html 即可查看生成的文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/43267