gulp
Créer une documentation avec gulp-jsdoc3

Installation

Tout d'abord, installez gulp et gulp-jsdoc3 dans votre projet:

npm install gulp-jsdoc3 --save-dev

Puis ajoutez-le à votre gulpfile.js

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



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

Pour documenter, par exemple, une fonction, vous devez ajouter un commentaire juste en haut de la fonction, comme ceci:

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

Si vous souhaitez en savoir plus sur les balises de bloc à utiliser, rendez- vous sur usejsdoc.org