Gulpを利用してJSDoc 3のドキュメント作成中のリアルタイム解析と効果プレビューを実現します.

異なるJavascript文書作成ツールについては、前に書いた文章「Javascript自動化文書ツール:YUI Doc、JSDoc 3、JSDuckなどの比較」を参照してください.ここではGulpに基づいて、対応する注釈が生成されたドキュメントを素早くプレビューするためのツールをどのように構築できるかについて説明します.
YUIDocに関するすべてのオススメ記事では、YUIDoc自身が備えるツールの一つとして挙げられています.YUIDoc Live Proview.このツールは、あなたが書いたコメントに対応して作成したドキュメントをより速くプレビューするのに役立ちます.コメントを保存して、ブラウザを開いて127.1.0.1:3000にアクセスするだけで、作成された文書スタイルが見えます.YUIDocの文法にまだ慣れていないので、繰り返し走るコマンドを減らしてデバッグするにはとても使いやすいツールです.
私はYUIDocのこの機能がとても気に入っています.そして、TerminalでJSDocの生成命令を繰り返しています.あまりにも面倒くさいので、自分でGulpを試してみます.JSDoc 3で類似の機能を実現することにしました.あくまでも実験をしやすいように、JSDoc 3及び実験によるGulpの使用は、実際の生産環境における効率の問題をあまり考えていません.
GulpはGrountと似たシナリオタスク定義、実行ツールです.Gulpに関する詳細な内容は公式サイトを参照してください.それはNodeJSのStream概念に依存して、Guntのようなファイルに対する繰り返し読みと書きを減少させました.同じタスクでGulpの定義を使うのは確かです.
Gulpの取り付け

npm install --save-dev gulp

JSDocもGulpも公式文書でGlobalとlocalをダブルインストールする方式を紹介しましたが、Stocoverflowの回答によれば、locallyインストールはアプリケーションの配置に確実に良いと思います.ユーザーが常にpackage.jsonを通じて最新/指定のmoduleを取得することを保証する一方、ローカルインストールにはsudo権限は必要なく、ユーザーの操作に多くの便利をもたらしている.locallyを使ってインストールしても、scriptを追加することによってコマンドラインを使用してコマンドを呼び出すことができます.例えば、以下のnpm run testを使用して、gulp testコマンドを呼び出すことができます./node-module/bin...

"devDependencies": {
     "gulp": "latest"
}
"scripts": {
     "test": "gulp test"
}

gulp-jsdocプラグイン

npm install --save-dev gulp-jsdoc

jsdocの最も主要な方法は以下の通りです.

jsdoc(destination, template, infos, options)

上記のパラメータの構造は以下の通りです.

template ＝ {
     path: 'path_to_template',
     anyTemplateSpecificParameter: 'whatever'
}

infos = {
     name: ''    //       ，   des       folder，        
     description: ''   
     version: ''  //       ，       folder       folder，           
     licenses: []
     plugins: false    //type: []
}

options = {
    'private': false,
    monospaceLinks: false,
    cleverLinks: false,
    outputSourceFiles: true
}

今のGulpの方式はまだTutorialとconf.jsonの中でsourceの濾過を支持することができません.jsdocの実行は実際にjsdoc.parserとjsdoc.generatorの二段階に分かれています.もしあなたのプログラムがこの二つのステップを別々に処理する必要があるなら、この二つの方法をそれぞれ呼び出してもいいです.
Gulpを利用してYUIのリアルタイムデバッグを実現するプログラム
タスクの実現ロジックは非常に簡単で、ドキュメントの出力位置、テンプレートなどを定義して必要な情報を生成した後、gulpにSrcフォルダの下でjsファイルに対する修正を監督させてもいいです.

var gulp = require('gulp'),
    jsdoc = require("gulp-jsdoc");

gulp.task('generate', function(){
     return gulp.src("./src/*.js")
            .pipe(jsdoc('./documentation-output'))
});
gulp.task('watch', function(){
     gulp.watch('./src/*.js', ['generate']);
});
gulp.task('default', ['generate']);

すべてが終わったら、あなたは必要です.

gulp watch

フォルダに対するリスニングを開始し、jsを保存すると最新の文書が作成されます.作成した文書があなたの心に合っているものかどうかすぐに確認できます.また、こっそりと言って、このような方法を使って、数日間JSDoc 3の使用を実験しましたが、文法が本当に硬すぎて、捨ててJSDuckを転用しました.