class IRB::ExtendCommand::Help

要約

irb 中の help コマンドのための拡張を定義したクラスです。

目次

インスタンスメソッド

execute

継承しているメソッド

IRB::ExtendCommand::Nopから継承しているメソッド

irb_context

インスタンスメソッド

execute(*names) -> nil[permalink][rdoc]

RI から Ruby のドキュメントを参照します。

irb(main):001:0> help String#match
...

[PARAM] names:: 参照したいクラス名やメソッド名などを文字列で指定します。

names を指定しなかった場合は、RI を対話的なモードで起動します。メソッド名などを入力する事でドキュメントの検索が行えます。入力のタブ補完をする事ができます。また、空行を入力する事で irb のプロンプトに戻る事ができます。

irb(main):001:0> help

Enter the method name you want to look up.
You can use tab to autocomplete.
Enter a blank line to exit.

>> String#match
String#match

(from ruby core)
------------------------------------------------------------------------------
  str.match(pattern)        -> matchdata or nil
  str.match(pattern, pos)   -> matchdata or nil
...