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

singleton method RDoc.usage

usage(*args) -> ()[permalink][rdoc] [added by rdoc/usage]

プログラムの使い方(RDoc.usage を呼び出したソースファイルの先頭に記述さ れたコメント)を標準出力に表示してプログラムを終了します。

数値に変換可能なオブジェクトを args[0] に指定した場合、終了ステータスを args[0] で指定した値にします。指定しなかった場合は 0 です。

[PARAM] args:

プログラムの終了ステータスや表示するセクションの指定を 配列で指定します。詳しくは rdoc/usage/使い方 を ご覧ください。