Buscar..


Instalación

En primer lugar, instale gulp y gulp-jsdoc3 en su proyecto:

npm install gulp-jsdoc3 --save-dev

Luego agrégalo a tu gulpfile.js

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



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

Para documentar, por ejemplo, una función, debe agregar un comentario justo en la parte superior de la función, como esto:

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

Si desea saber más etiquetas de bloque para usar, visite usejsdoc.org



Modified text is an extract of the original Stack Overflow Documentation
Licenciado bajo CC BY-SA 3.0
No afiliado a Stack Overflow