JsDoc Toolkitを使う!

テンプレート

最終更新:

aias-jsdoctoolkit

- view
管理者のみ編集可

トップページ > カスタマイズ >

テンプレート

テンプレート・システムの概要

JsDoc Toolkitはドキュメント出力のフォーマットを規定するための独自のテンプレート・システム"JsPlate"を持っています。JsDoc Toolkitの配布パッケージに同梱されている標準テンプレートはシンプルに"JsDoc"と名づけられています(templates/jsdoc/)。このページの解説を利用すれば、そのテンプレートをあなたが望むように改良したり、さらには自分自身でテンプレートを作成したりできるようになるはずです。

通常テンプレートは任意に名づけられた1つのフォルダ(例えば"jsdoc")にまとめられ、ドキュメント出力に使用するテンプレートを決定する -t コマンドラインオプションではそのフォルダパスが指定されます。フォルダ内のファイルは以下の3種類に分類されます。publish.jsを除き、テンプレートフォルダ内でのこれらのファイルやディレクトリの構成、名前などは完全に作成者の自由です。

publish.jsはテンプレート・システムの中心となるファイルで、ドキュメント出力のための実際の処理ロジックが記述されています。JsDoc Toolkitはドキュメント出力時にまずこのファイルを読み込み、その内容に従ってドキュメントの作成を実行します。
publish.jsはテンプレートフォルダの直下に存在していなければなりません。
publish.jsの記述方法に関する詳細はこちらを参照してください。
JsPlateファイル
(テンプレートファイル)
JsPlateファイルは実際に出力されるファイルの雛形となるファイルです。これらのファイルはpublish.jsによって読み込まれ、JsDoc Toolkitがソースコードからパースした様々な情報がその中に埋め込まれます。
JsPlateファイルは「テンプレートファイル」とも呼ばれます。また「テンプレート」という単語がJsPlateファイルを指すこともあります。
JsPlateファイルの記述方法に関する詳細はこちらを参照してください。
静的ファイル 出力されたドキュメントで使用されるjs、css、画像ファイルなどです。これらのファイルはJsDoc Toolkitによって加工されることはありませんが、publish.jsの記述に従ってファイルコピーされることで作成されるドキュメントの一部となります。

シンボルとは

以下の説明ではシンボルという言葉がよく使われますが、シンボルとはソースコードに含まれる関数、変数、クラス、メソッド、プロパティなどプログラムを構成する個々の要素の総称です。JsDoc Toolkitによってパースされたプログラムコードは、階層化され、互いに関連付けられたシンボルの集合として扱われます。  

関連項目


 

目安箱バナー