JSDocの書き方について簡単にメモしておく。
JSDocとは
JSDocとは、JavaScript用のAPIドキュメントジェネレータのこと。jsdocコマンドを実行することでHTML形式のドキュメントを作成することができる。
インストール方法
JSDocは、npmから以下のようにインストールできる。
// グローバルインストールの場合
npm install -g jsdoc
// ローカルインストールの場合
npm install --save-dev jsdoc
JSDocの主なタグ
JSDocで使用されるタグの一部を紹介する。
■ @param : 引数
/**
* @param {<型>} <引数名> - <説明>
*
* @param {string} name - 名前
*/
■ @return : 返り値
/**
* @return {<型>} <説明>
*
* @param {boolean} 真偽値を返す
*/
■ @throws : 例外
/**
* @throws {<型>} <説明>
*/
■ @classdesc : クラスの説明
/**
* @classdesc <クラスの説明>
*/
■ @constructor : コンストラクタ
/**
* <コンストラクタの説明>
* @constructor
*/
ドキュメントの作成
HTML形式のドキュメントを作成するには、jsdocをグローバルインストールした場合次のコマンドを実行する。
jsdoc <ソースフォルダ・ファイル名>