[Ruby] RDoc
Ruby の世界には Javadoc みたいなものがあるのかなぁ〜と探したら ありました。
RDoc というのが、 http://ruby.gfd-dennou.org/tutorial/rdoc/ あたりが 解りやすいかな。
Javadoc に比べると、
- ソースとそのコメントからHTMLのドキュメントを作る事は同じ
- Javadoc には @param みたなメソッドの引数や戻り値を書く形式が決まってるが RDoc にはそのようなルールない
- Javadoc では 文字を大きくしたとかボルドにした場合は HTML のタグを直接書くが RDoc では == や + のようなWiki的な記述を使う
- ソースコードをドキュメントに含める事ができる。 これは便利
など、など、
あの Rails も RDoc が公開されてます http://api.rubyonrails.org/ スタイルシートがRDoc標準と違ってカッコ良いです (さすがイケメン DHH :-)
