gulp
Erstellen Sie Dokumentation mit gulp-jsdoc3

Installation

Installieren Sie zunächst gulp und gulp-jsdoc3 in Ihrem Projekt:

npm install gulp-jsdoc3 --save-dev

Dann fügen Sie es Ihrer gulpfile.js hinzu

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



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

Um zum Beispiel eine Funktion zu dokumentieren, müssen Sie einen Kommentar ganz oben in der Funktion hinzufügen, z.

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

Wenn Sie mehr Block-Tags kennenlernen möchten, besuchen Sie usejsdoc.org