angular-jsdoc 与 npm

Question

使用 angular-jsdoc 我正在使用此命令生成我的文档

node .\node_modules\jsdoc\jsdoc.js app -c .\node_modules\angular-jsdoc\common\conf.json -d docs -t .\node_modules\angular-jsdoc\angular-template\

我不喜欢每次更新文档时都输入这么长的命令。

我想知道一些快捷方式，这样我就可以避免键入或 copy/pasting 这个命令。

Answer 1

因为命令指示 node 正在用于执行。我建议使用 npm 的功能来创建基于项目的命令。

这可以按如下方式完成：

1. 在您的主目录中创建一个 package.json 文件（使用 npm init）。
2. 在 package.json 文件中添加以下 json 对象

"scripts": { "gendoc":"node .\node_modules\jsdoc\jsdoc.js app -c .\node_modules\angular-jsdoc\common\conf.json -d docs -t .\node_modules\angular-jsdoc\angular-template\" }

这将为您的项目创建一个 gendoc 命令，可以从命令行执行，如下所示：

npm run gendoc

现在你不需要输入完整的命令，只需输入上面的命令，npm 将在 package.json 中搜索 scripts 对象 并执行键为 gendoc.

的脚本