gulp
Twórz dokumentację za pomocą gulp-jsdoc3
Szukaj…
Instalacja
Przede wszystkim zainstaluj gulp
i gulp-jsdoc3
w swoim projekcie:
npm install gulp-jsdoc3 --save-dev
Następnie dodaj go do pliku gulpfile.js
var gulp = require('gulp');
var jsdoc = require('gulp-jsoc3');
gulp.task('doc', function (cb){
gulp.src('src/*.js')
.pipe(jsdoc(cb));
});
Aby udokumentować na przykład funkcję, musisz dodać komentarz na samej górze funkcji, w następujący sposób:
/**
* @function example
* @summary This is a short description of example
* @author Whoever
* @param {any} cb
* @returns
*/
function example(cb){
//Code
}
Jeśli chcesz poznać więcej tagów blokowych do użycia, odwiedź usejsdoc.org
Modified text is an extract of the original Stack Overflow Documentation
Licencjonowany na podstawie CC BY-SA 3.0
Nie związany z Stack Overflow