设置一个基本的Gulpfile来运行JSDoc

Question

我正在努力了解当前gulpfile中缺少的内容，以使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或Gulp的一些基本理解。

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时，您将生成文档。