JsDoc Toolkit †
Nov 13, 2007, 00:44
Hello JsDoc Toolkit †
JavaScript専用のドキュメントジェネレータ。
Natural Docsの様に冗長にならずに、Javadoc風の記述が可能。
JSDocよりも正確に文法を解釈できる。
生成処理は全てJavaScriptで書かれているので、カスタマイズも容易。
日本ではいまいち認知度が低いようだけど、
僕の知る限り最高のJavaScriptドキュメントジェネレータ。
Related Links †
Install †
OSXしか試していないけど、
cdで移動しないと正常に動作しないので、※ パス指定できない、改善希望
使い易い場所が良いと思う。
Command Line Options †
| オプション | 説明 | 備考 |
| -c | JSON形式のコンフィグファイル | 殆どこれで足りる気がする、 クォーテーションなど厳密なJSON形式でなくてもOKっぽい |
| -r | 対象の階層の深さ | デフォルトは1階層だけ潜る（変わった？） |
| -t | 使用テンプレート | |
| -d | 出力ディレクトリ | |
| -x | 対象拡張子 | デフォルトは"js"だけ |
| -D | 変数定義 | テンプレートに対して渡すもの |
Memo †
詳しい事は公式サイトにあるので、mad template用のメモだけ
Ver 1.3.1 †
- コンフィグ対応
- @overviewが空だった時のメッセージが無くなった
- 変数定義対応
publish.js †
| 変数 | 説明 | 備考 |
| fileGroup | 今のところfilesを格納しているだけ？ | |
| fileGroup.files | ファイルリスト | |
| context | コマンドラインからの引数リスト | |
| context.c | コンフィグファイルのパス | |
| context.t | テンプレートのパス | |
| context.d | 出力ディレクトリのパス | |
| context._ | 対象ディレクトリの配列？ |
Dumper.js †
| 関数 | 説明 | 備考 |
| Dumper.dump | オブジェクトをダンプできるので便利 |