RIとRDOCの違いは何ですか

StackOverflow https://stackoverflow.com/questions/3643904

  •  30-09-2019
  •  | 
  •  

質問

gemsをインストールするたびに、Riとrdocが続きます。これはドキュメントであることは知っていますが、2つの違いとそれらの使用方法は何ですか？

役に立ちましたか？

解決

RDOC [..]は、Rubyプログラミング言語の埋め込みドキュメントジェネレーターです。 [..] RDOCは、Rubyコア分布の一部として含まれています。

RDOCは、Ruby Riデータファイルを作成するためのエンジンも提供します。 RIは（多かれ少なかれ）RubyのMan Pagesのバージョンであり、コマンドラインからAPI情報を提供しています。

から：http://en.wikipedia.org/wiki/rdoc

他のヒント

宝石のローカルRDOCにアクセスするには、タイプ gem server ブラウザに向けてください http://localhost:8808.

宝石のRDOCがインストールされていない場合、 gem rdoc --allすべての宝石のドキュメントをインストールします。

ローカルドキュメントは必要ないように思えるかもしれません。多くの開発者は、オンラインドキュメントを支持して意図的にインストールするスキップをスキップしています。ただし、Rails 2のようなレガシーツールを使用している人にとっては、適切なドキュメントを迅速かつ簡単に見つけることができます。

  • RDoc コードのコメントと構造からドキュメントを自動的に生成します。 https://github.com/rdoc/rdoc だからドキシゲンを考えてください。それを使用して、作成したコードの自動ドキュメントを生成します。
  • ri たとえば、インターネットがない場合など、オフラインヘルプファイルです。 http://www.caliban.org/ruby/rubyguide.shtml#ri 考え perldoc. 。クラスについて質問がある場合は、使用してください。 ri Enumerator 育てるべきです

Enumerator <Object

= include：列挙可能（Ruby Coreから）

（Ruby Coreから）--------------------------------------------------------- ---------------------------------------------------------------------------外部反復の両方を可能にするクラス。

列挙器は、次の方法で作成できます。 * kernel＃to_enum * kernel＃enum_for * enumerator.new

ほとんどの方法には、列挙の各アイテムについて内容が評価されるブロック形式と、反復を包む新しい列挙器を返すブロック形式の2つのフォームがあります。

Enumerator =％w（1つの2つの3）.each Puts Enumerator.Class＃=> Enumerator Enumerator.each_with_object（ "foo"）do | item、obj | puts "＃{obj}：＃{item}" end＃foo：one＃foo：2＃foo：3 enum_with_obj = enumerator.each_with_object（ "foo"）puts enum_with_obj.class＃=> enumerator enum_with_obj.each |アイテム| obj | puts "＃{obj：＃{item}" end＃foo：one＃foo：2＃foo：3

これにより、列挙者を一緒にチェーンすることができます........

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top