gem をインストールするたびに、ri と rdoc が続きます。これがドキュメントであることは知っていますが、2つの違いと使用方法は何ですか?
3 に答える
RDoc [..] は、Ruby プログラミング言語用の埋め込みドキュメント ジェネレーターです。[..] RDoc は、Ruby コア ディストリビューションの一部として含まれています。
RDoc は、Ruby ri データ ファイルを作成するためのエンジンも提供します。ri は (多かれ少なかれ) Ruby のマニュアル ページのバージョンであり、コマンド ラインから API 情報を提供します。
gem のローカル RDoc にアクセスするにはgem server
、ブラウザに を入力してポイントしますhttp://localhost:8808
。
gem の RDoc がインストールされていない場合は、gem rdoc --all
すべての gem のドキュメントがインストールされます。
ローカル ドキュメントは必要ないように思われるかもしれません。多くの開発者は、オンライン ドキュメントを優先して、故意にインストールをスキップします。ただし、Rails 2 などのレガシー ツールを使用している私たちにとっては、適切なドキュメントをすばやく簡単に見つけることができます。
RDoc
は、コードのコメントと構造からドキュメントを自動的に生成します。https://github.com/rdoc/rdoc Doxygen を考えてみてください。これを使用して、記述したコードの自動ドキュメントを生成します。ri
たとえば、インターネットがない場合のオフライン ヘルプ ファイルです。http://www.caliban.org/ruby/rubyguide.shtml#ri考えてみてくださいperldoc
。クラスについて質問がある場合に使用しますri Enumerator
。
列挙子 < オブジェクト
= 内容: 列挙可能 (Ruby コアから)
(ルビーコアから) --------------------------------------------- --------------------------------- 内部反復と外部反復の両方を許可するクラス。
Enumerator は、次のメソッドで作成できます。* Kernel#to_enum * Kernel#enum_for * Enumerator.new
ほとんどのメソッドには 2 つの形式があります。列挙内の項目ごとに内容が評価されるブロック形式と、反復をラップする新しい Enumerator を返す非ブロック形式です。
enumerator = %w(one two three).each puts enumerator.class # => Enumerator enumerator.each_with_object("foo") do |item,obj| puts "#{obj}: #{item}" end # foo: one # foo: two # foo: three enum_with_obj = enumerator.each_with_object("foo") puts enum_with_obj.class # => Enumerator enum_with_obj.each do |item,オブジェクト| puts "#{obj: #{item}" end # foo: one # foo: two # foo: three
これにより、列挙子を連鎖させることができます........