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 를 방문하십시오 .