安装

首先，将 gulp 和 gulp-jsdoc3 安装到你的项目中：

npm install gulp-jsdoc3 --save-dev

然后将其添加到你的 gulpfile.js

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

gulp.task('doc', function (cb){
    gulp.src('src/*.js')
    .pipe(jsdoc(cb));
});

例如，为了记录函数，你必须在函数顶部添加注释，如下所示：

/**
 * @function example
 * @summary This is a short description of example
 * @author Whoever
 * @param {any} cb
 * @returns 
 */
function example(cb){
    //Code
}

如果你想了解更多块标签，请访问 usejsdoc.org