シリコンバレー ２４時

« 2006年12月21日

メイン

2006年12月23日 »

2006年12月22日

RI コマンド

ここのところ、Rubyのドキュメント関連である 「RD」、「RDoc」について書いてきているが、その続きとして 「RI」というコマンドがあるので、それについても調査報告。

まず、「RI」コマンドについては Ruby リファレンスマニュアル の 「ri」 に書いてあるが、このページによると、

コマンドラインから RDoc で書かれた Ruby のリファレンスを引くことができます。

と解説してある。 この「RI」コマンドも 「RDoc」コマンド同様に Rubyのシステムにデフォルトでインストールされているコマンドである。 実際に試してみると、 ウィンドウズ上のRuby mswin32版では、このコマンドは バッチファイル「ri.bat」として して実装されている。

使用方法としては、調べたいクラスやメッソドを単に 「ri」コマンドの引数にすればよく、 例えば Array クラスについて知りたければ、

C:\>ri Array
----------------------------------------------------------- Class: Array
     Arrays are ordered, integer-indexed collections of any object.
     Array indexing starts at 0, as in C or Java. A negative index is
     assumed to be relative to the end of the array---that is, an index
     of -1 indicates the last element of the array, -2 is the next to
     last element in the array, and so on.

------------------------------------------------------------------------


Includes:
---------
     Enumerable(all?, any?, collect, detect, each_cons, each_slice,
     each_with_index, entries, enum_cons, enum_slice, enum_with_index,
     find, find_all, grep, include?, inject, inject, map, max, member?,
     min, partition, reject, select, sort, sort_by, to_a, to_set, zip)


Class methods:
--------------
     [], new


Instance methods:
-- More  --

となる。 また、「ri -l」とすると表示可能な クラス、モジュール、メソッド が一覧表示される。

C:\>ri -l
Abbrev
Abbrev#abbrev
Acceptables
ACL
ACL::new
ACL#allow_addr?
ACL#allow_socket?
ACL#install_list
ACL::ACLEntry
ACL::ACLEntry::new
ACL::ACLEntry#dot_pat
ACL::ACLEntry#dot_pat_str
ACL::ACLEntry#match
ACL::ACLList
ACL::ACLList::new
ACL::ACLList#add
ACL::ACLList#match
AmbiguousArgument
AmbiguousOption
Arguable
Arguable::extend_object
Arguable::new
Arguable#getopts
Arguable#options=
-- More  --

以前のブログ 「Eclipse への RDTプラグイン インストレーション」 で紹介したとおり、 Eclipse 上に Rubyの開発環境 RDT(Ruby Development Tools) をインストレーションする際、 「Ri/rdoc」の項目でパスの設定を行わなければならない。 この設定を行っておくと、Eclipse 上で「RI」ビューが表示できるようになる。

もしEclipse 上に 「RI」ビューが表示されていなければ、 メニューから［Window］−［Show View］を選択すると Consoleをはじめ、表示できるが選択できるが、 その中に「RI」という項目もある。 この「RI」を選択すると、 RIコマンドの出力を専用のビューで確認することができ、 クラス、モジュール、メソッド に関する一種のオンライン・ヘルプ となる。

Eclipse 上の「RI」ビューは 大きく左右に分かれている。 左側には クラスやメソッドが ABC順に表示されており、 これがおそらく「ri -l」の出力結果であろう。 この中から 詳しく知りたい 項目をクリックすると 右側にその内容が表示される。 ここでの表示は、きれいに整形されているので ターミナル上で見るよりずっと見やすくになっている。

【参考リンク】

• Ruby リファレンスマニュアル
• ri

カテゴリー: Ruby     22:25 | コメント (0) | トラックバック (0)

« 2006年12月21日

メイン

2006年12月23日 »