gulp
Skapa dokumentation med gulp-jsdoc3

Installation

Först och främst, installera gulp och gulp-jsdoc3 i ditt projekt:

npm install gulp-jsdoc3 --save-dev

Lägg sedan till den i din gulpfile.js

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



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

För att till exempel kunna dokumentera en funktion måste du lägga till en kommentar längst upp i funktionen, så här:

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

Om du vill veta mer blocktaggar att använda, besök usejsdoc.org