設置一個基本的Gulp文件來運行JSDoc

Question

我很努力地理解我當前的gulp文件中缺少的東西，以使JSDoc高興。

下面的代碼不會導致任何錯誤被拋出，但看着生成的文檔的索引頁，很明顯我的文檔沒有被格式化。

缺少什麼我在這裏？

首先，這裏是我想要記錄的功能。

/** 
* Returns the sum of a and b 
* @param {Number} a 
* @param {Number} b 
* @return {Number} Sum of a and b 
*/ 
var sum = function(a, b){ 
    return a + b; 
}; 

接下來，這裏是我的gulpfile.js

var gulp = require('gulp'); 
var jsdoc = require('gulp-jsdoc'); 

gulp.task('js-doc', function(){ 
    return gulp.src([ 'app.js' ]) 
    .pipe(jsdoc.parser({}, 'test')) 
    .pipe(jsdoc.generator('./docs')); 
}); 

有一次，我跑gulp js-doc，它創建docs /目錄下，並建立了文檔。但是，訪問瀏覽器中的index.html頁面顯示沒有實際生成文檔。當我看到app.js.html，另一個由JSDoc生成的文件時，我看到了我的代碼塊，但是沒有任何文件被解析並轉化爲實際的文檔。見下面的截圖。

我覺得我失去了JSDoc或咕嘟咕嘟的一些基本認識。

Answer 1

想通了：

npm install --save jsdoc gulp-shell

然後，你裏面在gulpfile.js下面粘貼要求和任務：

var gulp = require('gulp'); 
var shell = require('gulp-shell'); 

gulp.task('js-doc', shell.task(['./node_modules/jsdoc/jsdoc .'])); 

現在，當您運行命令行gulp js-doc，你將生成文檔。