gulp
Maak documentatie met gulp-jsdoc3

Installatie

Installeer eerst gulp en gulp-jsdoc3 op uw project:

npm install gulp-jsdoc3 --save-dev

Voeg het dan toe aan je gulpfile.js

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



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

Om bijvoorbeeld een functie te documenteren, moet u een opmerking toevoegen bovenaan de functie, zoals deze:

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

Ga naar usejsdoc.org als u meer bloktags wilt weten om te gebruiken