gulp
Создайте документацию с помощью gulp-jsdoc3
Поиск…
Монтаж
Прежде всего, установите gulp
и gulp-jsdoc3
к вашему проекту:
npm install gulp-jsdoc3 --save-dev
Затем добавьте его в свой файл gulpfile.js
var gulp = require('gulp');
var jsdoc = require('gulp-jsoc3');
gulp.task('doc', function (cb){
gulp.src('src/*.js')
.pipe(jsdoc(cb));
});
Чтобы документировать, например, функцию, вам нужно добавить комментарий только в верхней части функции, например:
/**
* @function example
* @summary This is a short description of example
* @author Whoever
* @param {any} cb
* @returns
*/
function example(cb){
//Code
}
Если вы хотите узнать больше тегов блоков для использования, перейдите на страницу usejsdoc.org
Modified text is an extract of the original Stack Overflow Documentation
Лицензировано согласно CC BY-SA 3.0
Не связан с Stack Overflow