161847f8eSopenharmony_ci# JSDoc format 261847f8eSopenharmony_ci 361847f8eSopenharmony_ci## 简介 461847f8eSopenharmony_ci 561847f8eSopenharmony_ci此工具可以将 d.ts 声明文件进行格式化处理并输出新的 d.ts 声明文件。 661847f8eSopenharmony_ci 761847f8eSopenharmony_ci## 使用方法 861847f8eSopenharmony_ci 961847f8eSopenharmony_ci* 调试阶段 1061847f8eSopenharmony_ci 1161847f8eSopenharmony_ci ```shell 1261847f8eSopenharmony_ci npm install 1361847f8eSopenharmony_ci ts-node ./src/main.ts -i input.d.ts -o output.d.ts 1461847f8eSopenharmony_ci ``` 1561847f8eSopenharmony_ci 1661847f8eSopenharmony_ci 命令行参数： 1761847f8eSopenharmony_ci 1861847f8eSopenharmony_ci -i：指定需要格式化的 d.ts 文件或者包含 d.ts 文件的目录 1961847f8eSopenharmony_ci 2061847f8eSopenharmony_ci -o：指定新文件的名字或者输出目录 2161847f8eSopenharmony_ci 2261847f8eSopenharmony_ci 注意：-i 指定的是文件，则 -o 参数需要指向文件。-i 指定的是目录，-o 参数需要指向目录。 2361847f8eSopenharmony_ci 2461847f8eSopenharmony_ci* 打包成 bundle(bundle.js 是可以独立运行的完整工具) 2561847f8eSopenharmony_ci 2661847f8eSopenharmony_ci ```shell 2761847f8eSopenharmony_ci npm run build 2861847f8eSopenharmony_ci node build/bundle.js -i input.d.ts -o output.d.ts 2961847f8eSopenharmony_ci ``` 3061847f8eSopenharmony_ci 3161847f8eSopenharmony_ci bundle.js 在 build 目录下，命令行参数与调试阶段一样。 3261847f8eSopenharmony_ci 3361847f8eSopenharmony_ci完整的命令行参数可通过 -h 参数获得： 3461847f8eSopenharmony_ci 3561847f8eSopenharmony_ci```shell 3661847f8eSopenharmony_ciUsage: jsdoc-tool [options] 3761847f8eSopenharmony_ci 3861847f8eSopenharmony_ciCLI to format d.ts 3961847f8eSopenharmony_ci 4061847f8eSopenharmony_ciOptions: 4161847f8eSopenharmony_ci -V, --version output the version number 4261847f8eSopenharmony_ci -i, --input <path> d.ts文件或包含d.ts的文件夹 4361847f8eSopenharmony_ci -o, --output <path> 新的d.ts输出文件或目录 4461847f8eSopenharmony_ci -l, --logLevel <INFO,WARN,DEBUG,ERR> 日志输出级别[INFO,WARN,DEBUG,ERR] (default: "INFO") 4561847f8eSopenharmony_ci -s, --split 是否拆分接口 (default: false) 4661847f8eSopenharmony_ci -h, --help display help for command 4761847f8eSopenharmony_ci``` 4861847f8eSopenharmony_ci 4961847f8eSopenharmony_ci## 报告 5061847f8eSopenharmony_ci 5161847f8eSopenharmony_ci在上述命令成功执行完后，会同时生成一个 .xlsx 报告。可根据报告提示，修改错误。 5261847f8eSopenharmony_ci 5361847f8eSopenharmony_ci报告出现在 -i 输入的文件/文件夹的同级目录，命名方式为 文件(夹)名_时间戳.xlsx 54