YUIDocを使ってJavaScriptのドキュメントを生成する

dorako321

8年前

YUIDocのインストール

$ sudo npm -g install yuidocjs

1	$ sudo npm -g install yuidocjs

インストールが完了したのでバージョンを確認

$ yuidoc -v
0.10.1

1 2	$ yuidoc -v 0.10.1

ドキュメントを作成する

javascriptのコードにドキュメントを追加します。javadocと同じで/* */ ではなく/** */でコメントを記述します。

/**
 * @class Math
 */


/**
 * @method sum
 * @param {Number | String } a 
 * @param {Number | String } b
 * @return {Number | String} 和の数値または連結された文字列
 */
exports.sum = function(a, b) {
    return a + b
};

/**

* @class Math

/**

* @method sum

* @param {Number | String } a

* @param {Number | String } b

* @return {Number | String} 和の数値または連結された文字列

exports.sum = function(a, b) {

return a + b

};

ドキュメントを出力する

$ yuidoc -o yuidoc -c src/yuidoc.json js/

1	$ yuidoc -o yuidoc -c src/yuidoc.json js/

出力結果は以下

綺麗に整形されていますね。