YUIDocを使ってJavaScriptのドキュメントを生成する
YUIDocのインストール
|
1 |
$ sudo npm -g install yuidocjs |
インストールが完了したのでバージョンを確認
|
1 2 |
$ yuidoc -v 0.10.1 |
ドキュメントを作成する
javascriptのコードにドキュメントを追加します。javadocと同じで/* */ ではなく/** */でコメントを記述します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
/** * @class Math */ /** * @method sum * @param {Number | String } a * @param {Number | String } b * @return {Number | String} 和の数値または連結された文字列 */ exports.sum = function(a, b) { return a + b }; |
ドキュメントを出力する
|
1 |
$ yuidoc -o yuidoc -c src/yuidoc.json js/ |
出力結果は以下
綺麗に整形されていますね。