[Grunt & Yeoman] grunt-contrib-yuidoc で JavaScript のドキュメントを生成する
grunt-contrib-yuidoc は、JavaScript のドキュメント生成ツール。
インストール
% npm install grunt-contrib-yuidoc --save-dev
Gruntfile
オプション。
# grunt-contrib-yuidoc
yuidoc:
compile:
name: '<%= pkg.name %>'
description: '<%= pkg.description %>'
version: '<%= pkg.version %>'
url: '<%= pkg.homepage %>'
options:
paths: 'src/javascripts/'
outdir: 'docs/YUIDoc'
つかいかた
コメントを書く。
/**
* This is the description for my class.
*
* @class MyClass
* @constructor
*/
function hoge() {
"use strict";
var foo = " hoge fuga";
console.log(foo);
}
hoge();
% grunt yuidoc
Running "yuidoc:compile" (yuidoc) task
Start YUIDoc compile...
Scanning: ./src/javascripts/
Output: docs/YUIDoc
YUIDoc compile completed in 0.195 seconds
Done, without errors.
% open docs/YUIDoc/index.html