- 追加された行はこの色です。
- 削除された行はこの色です。
[[プログラミング言語/Ruby]]
*RDoc [#d777ceb5]
RDocとは、JavaのJavaDocのような、ソース中のコメントを解析して
生成されるRubyドキュメント形式です。
このドキュメント生成ユーティリティはRuby本体に標準添付され、
コマンドラインからrdocで呼び出せます。
処理できるのは、Rubyスクリプトはもちろん、Ruby用拡張ライブラリの
C言語ソースコードも扱えます。
(なぜか、Fortran99にも対応しています :-)
**使い方 [#x4c7bde9]
$ rdoc
で、カレントディレクトリ以下のソースコードをすべて解析して
doc/というディレクトリにHTML形式のドキュメントを生成します。
doc/というディレクトリにHTML形式とri形式のドキュメントを生成します。
**基本的な書き方 [#q1d596cc]
「#」によるコメント行の連続をひとつのかたまり(ブロック)として扱います。
# ファイル先頭のブロック:
# ファイルについてのドキュメント
#
# クラス定義前のブロック:
# クラスについてのドキュメント
#
class SomeClass
# メソッド定義前のブロック:
# メソッドについてのドキュメント
#
def some_method(arg)
...
end
end
ただ説明を書いておくだけでも有効なドキュメントになるのは
間違いないですが、このブロック中にはSimpleMarkupと呼ばれる
専用のマークアップ文法が使えます。
**SimpleMarkup [#qca52b12]