JavaScriptのドキュメントフォーマットにはどんなものがあるの？

ちょっと必要そうなので簡単に調べてみた。

JSDoc(Perl)

• http://jsdoc.sourceforge.net/
• 開発中止

JsDocToolkit(Rhino on Java)

• http://code.google.com/p/jsdoc-toolkit/
• MITライセンス
• JSDocの後継プロジェクト
• JSDocの主要メンバーだったMichael Mathewsが開発

JSDocはやめたほうがよさそう

• prototypeベースのコードを解釈(+ 手動によるClassとメンバーの紐付けも)できないかも
  • うそ、できた
• おそらくアノテーションできない
  • @typeの表現がJsDocToolkitと違う

JsDocToolkit使った方が良さそう

• いろんな書き方ができそう
• メンテナンスされているみたい
• Google Closure CompilerはJsDocToolkitの型表現を使ってアノテーションを行っている
  • http://code.google.com/intl/ja/closure/compiler/docs/js-for-compiler.html#types

JsDocToolkit

• ドキュメント記述形式はJavaDocベース
• コアの構文解析機能とテンプレート機能が別になっているので出力するもののデザインを変更することができる
• Rhino上で解釈できるJSコードであれば最小限の記述だけでドキュメントが生成できる

ドキュメントを生成するまでの簡単な流れ

• 環境の用意
  • RHINOが動く環境(要Java)
  • ダウンロード
    • http://code.google.com/p/jsdoc-toolkit/downloads/list

• ドキュメントを書く

• 生成する
  • @win java -jar jsrun.jar app\run.js c:\example\js\ -t=templates\jsdoc -d=c:\out\example -a
  • @linux java -jar jsrun.jar app/run.js test.js -t=templates/jsdoc -d=sample -a

• ブラウザで見る

ライブラリを使っている場合

• Prototype Library-Based Classes
  • http://code.google.com/p/jsdoc-toolkit/wiki/CookBook

疑問

• Prototypeで書かれたものってClosureCompilerでちゃんとアノテーションされるの？？