JSDoc を使ってみた

JavaScript

http://jsdoc.sourceforge.net/
インストールは簡単。圧縮ファイルを適当なところに展開するだけ。windowsなのでパスの通っているところに jsdoc.cmd を作って

@perl c:\bin\jsdoc\jsdoc.pl %1 %2 %3 %4 %5 %6 %7 %8 %9

とした。これで

 jsdoc hogehoge.js

とするとAPIリファレンスができる。で、

 * @constructor

コメント中にこの指定がないと認識しないクラスが多いことに注意すれば、他は特に問題ないかと。試行錯誤の中でやり方はおぼわると思う。


で、使用感だが。びみょー。
ドキュメントが英語なのでろくに読めておらず、オプションで何とかなる問題なのかもしれないけど。

  1. hoge.prototype.huga=function(){ .... } のような形にも対応している。
  2. オブジェクト形式での定義（ uty={ set:function(){ ... } } みたいなの）には対応していない
  3. 名前空間的にオブジェクトを使うと認識が変になる（ http://d.hatena.ne.jp/nazoking/20050425/1114374965 ）
  4. arguments を使ったりする省略可能な引数とか、javaならオーバーロードを使うような引数の型・個数が変化するようなメソッドをどう書いていいか分からない


で、微妙。つうか僕の書き方がひねくれすぎなのか？ひねくれているからこそ、後からドキュメントが欲しくなるわけだが…