JsDoc Toolkitを使う!
カスタマイズ
最終更新:
aias-jsdoctoolkit
トップページ >
カスタマイズ
以下のページでは、JsDoc Toolkitをカスタマイズする方法について説明します。
テンプレート
JsDoc Toolikitの機能は大きくソースコードのパースを担当するコア機能とドキュメントの整形と出力を担当するテンプレート機能に分けられます。テンプレートは-tコマンドラインオプションで簡単に切り替えられ、規定の形式に則ったテンプレートを用意すれば誰でも独自構成のドキュメントを作成することができるようになっています。
ここではテンプレート・システムの仕様と新しいテンプレートを作成する方法を説明します。
プラグインの追加
プラグインはバージョン2からの新しい機能で、ソースコードのパース段階のJsDoc Toolkitの動作にある程度の独自処理を追加する仕組みを提供します。ここではプラグインの仕様と作成方法を説明します。
組み込みオブジェクト リファレンス
JsDoc Toolkitがソースコードからパースした結果を表すSymbolオブジェクトやファイルを操作するための IO ネームスペースなど、カスタマイズに必要な組み込みオブジェクトのインターフェース情報を提供します。