角jsdoc与NPM

Question

使用角jsdoc我使用这个命令生成我的文档

节点。\ node_modules \ jsdoc \ jsdoc.js应用-c。\ node_modules \角jsdoc \常见\ conf.json -d文档-t \ node_modules \角jsdoc \角模板\

我不喜欢打字这么长的命令的每次更新我的文档。

我想知道一些快捷方式，以便我可以避免键入或复制/粘贴此命令。

Answer 1

由于该命令表示节点正被用于执行。我建议使用npm的功能来创建基于项目的命令。

1. 在你的主目录下创建的package.json文件（使用NPM INIT）：

   这可以如下完成。

2. 添加以下JSON对象中的package.json文件

“脚本”：{ “gendoc”：“节点\ node_modules \ jsdoc \ jsdoc.js应用-c \ node_modules \角。 -jsdoc \ COMMON \ conf.json -d文档-t \ node_modules \角jsdoc \角模板\” }

这会为项目创建一个gendoc命令，它可以从执行命令行如下：

NPM运行gendoc

现在你不需要输入完整的命令，只需输入上述命令，故宫将搜索脚本对象的package.json并执行脚本其关键是gendoc。