JSDocで関数定義の仕様書を生成する

公式ドキュメント

JSDocのインストール

$ sudo npm install -g jsdoc

JSDocの使い方

以下のようなmain.jsファイルがあったとします。JSDocの特有のコメントの記述にしたがって、ドキュメントが生成されます。

/**
合計値を算出する
@param {number} left 左辺値
@param {number} right 右辺値
@return {number} 合計値
@example
    sum(1, 2); //=> 3
    sum(1); //=> NaN
*/
function sum(left, right){
    return left + right;
}

/**
平均値を算出する
@param {number} left 左辺値
@param {number} right 右辺値
@return {number} 合計値
@example
    ave(1, 3); //=> 2
    ave(1); //=> NaN
*/
function ave(left, right){
    return (left + right) / 2;
}

ドキュメントを生成したいjsファイルのあるディレクトリにcdし、以下のコマンドを実行します。

$ jsdoc main.js

複数のjsファイルを指定することもできます。

jsdoc main.js sub.js

そのディレクトリにoutディレクトリが生成され、その中にHTML形式でドキュメントが生成されます。

尚、以下のコマンドでヘルプが表示されます。

jsdoc -h