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 पर जाएं