gulp
Crea documentazione con gulp-jsdoc3

Installazione

Prima di tutto, installa gulp e gulp-jsdoc3 nel tuo progetto:

npm install gulp-jsdoc3 --save-dev

Quindi aggiungilo al tuo gulpfile.js

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



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

Per documentare, ad esempio, una funzione, devi aggiungere un commento nella parte superiore della funzione, in questo modo:

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

Se vuoi sapere più tag di blocco da utilizzare, visita usejsdoc.org