Node.js+gulp+jsdocでAPIドキュメントを生成

2650 ワード
gulp JSDoc Node.js Node.js テキストリンク

Node.jsを初めて11日目か12日目
ドキュメントを生成したくなりました。
その時のメモ

gulp-jsdocを使います

インストール

npm install gulp-jsdoc

使い方

単にソースフォルダのファイルを指定する場合

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

gulp.src("./src/*.js")
  .pipe(jsdoc('./documentation-output'))

jsdoc.parserを使う場合

gulp.src("./src/*.js")
  .pipe(jsdoc.parser(infos, name))
  .pipe(gulp.dest('./somewhere'))

infosには下記のような値を設定可能

infos.name

Type: String
Default: ''

infos.description

Type: String
Default: ''

infos.version

Type: String
Default: ''

infos.licenses

Type: Array
Default: []

infos.plugins

Type: Array
Default: false
例: ['plugins/markdown']