JavaScript でドキュメント生成。 YUI Doc

YUI Doc はコメント駆動のドキュメント生成ツール。
YUI Doc を使うと JavaScript のコメントからドキュメントを生成できるそうな。


Java で開発したことのある人ならば Javadoc というツールを知っていると思うけど、YUI Doc も丁度そんな感じ。


使えるタグは Javadoc とは全然違うみたい。(そりゃそうでしょうけどねと)
実際に使うには Python が必要みたい。(なるほどねと)


http://developer.yahoo.com/yui/yuidoc/


覚えておくと良いかもですね。


因みに、メソッドのコメントに(コードを一対一で日本語表現するような)内部の詳細を書いて Javadoc で生成し、内部設計書の代用にしているのをよく見かけますが、僕はそれをあまり良いと思っていません。
事前条件や事後条件などを含めて、外部仕様を丁寧に書くのが良いと思っています。