gulp
gulp-jsdoc3でドキュメントを作成する

インストール

まず、インストール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をご覧ください。