角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。