安裝
首先,將 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