Rubyでもドキュメンテーション - Start! Ruby

Rubyでもドキュメンテーション

RDocを使ってみよう！

RDocの"書きどころ"は、JavaDocなどと同じ。
クラスの前、メソッドの前、シンボルの前、ファイルのトップなど。

# ドキュメンテーション

と、コメントのように書くだけでOK。

修飾してみよう！

作成者やライセンス情報などの書き方

#Authors::   MitiM
#Version::   1.0
#Copyright:: Copyright (C) MitiM, 2010. All rights reserved.
#License::   Ruby License

基本的に::で区切れば、好きな項目を作成可能。

見出し<H1>～<H3>は

#= 見出しレベル1
#== 見出しレベル2
#=== 見出しレベル3

箇条書きは、-(*)で・。+でナンバリング。

#- レベル1
#  - レベル2
#+ レベル1
#  + レベル2

RDoc内でコメントにしたいなら

#--
# この中はドキュメンテーションされない
#++

RDocとして書き出すのは

$ rdoc [ソースファイル.rb]