Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > rdoc/usageライブラリ

library rdoc/usage

要約

プログラムの使い方(RDoc.usage を呼び出したソースファイルの先頭に記述さ れたコメント)を表示するためのサブライブラリです。

[注意] rdoc/usage ライブラリは 1.9 系では廃止されました。

使い方

以下のように実行します。exit_status、section のどちらも省略可能です。

RDoc.usage(exit_status, section, ...)
RDoc.usage_no_exit(section, ...)

それぞれの引数は以下のような意味です。

exit_status

プログラムの終了ステータスを数値に変換可能なオブジェクトで指定します。 指定しなかった場合は 0 です。

section

見出し部に指定した名前を 1 つ、または複数指定します。指定があれば、そ の見出しの部分だけを表示し、指定しなかった場合は全て表示します。見出 しレベルや名前の大文字、小文字の区別はありません。

使用例

以下のように使用します。実際には RDoc::usage の行を適宜コメントアウトし て実行してください。

# Comment block describing usage
# with (optional) section headings
#
# = Summary
# . . .
# == Author
# . . .
# == Copyright
# . . .

require 'rdoc/usage'

# プログラムの使い方を全て表示し、終了ステータス 0 でプログラムを終了。
RDoc::usage

# プログラムの使い方を全て表示し、終了ステータス 99 でプログラムを終
# 了。
RDoc::usage(99)

# 「= Summary」から「== Author」の手前までを表示し、終了ステータス
# 99 でプログラムを終了。
RDoc::usage(99, 'Summary')

# Author、Copyright を表示し、終了ステータス 0 でプログラムを終了。
RDoc::usage('Author', 'Copyright')

# Author、Copyright を表示し、プログラムを継続。
RDoc::usage_no_exit('Author', 'Copyright')

同時にrequireされるライブラリ

cgi

CGI プログラムの支援ライブラリです。

rdoc/markup/simple_markup

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

rdoc/markup/simple_markup/to_flow

RDoc 形式のドキュメントを表示する一段階前の構造化された状態にするための サブライブラリです。

追加・再定義されるメソッド

RDoc.usage RDoc.usage_no_exit