Rubyのドキュメントを取得する最速の方法は何ですか？ [閉まっている]

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

  •  02-07-2019
  •  | 
  •  

質問

Rubyコードを書いているので、標準の日付型を使用して現在の日付を取得したいとします。検索エンジンを使用する代わりに、このクラスのドキュメントをすばやく見つける方法はありますか？ Date.methods と入力することでDateのメソッドを取得できることは知っていますが、私が知る限り、引数の型や戻り値に関する詳細は提供していません。

編集者固有の回答を歓迎します。私が選んだエディターはEmacsです。

役に立ちましたか？

解決

Rubyコアドキュメント

をブックマークします。

Webブラウザのテキスト検索コマンドを使用します。

予想外のことですが、これは ri を使用するよりも実際に高速です。何らかの理由で起動に時間がかかるようです。

また、 ri よりもはるかに優れています。HTMLページには、1つのページ上のすべてのメソッドのすべてのドキュメントが一覧表示されるためです。多くの場合、メソッドは他のメソッドに関連しており、2つの ri を切り替えるのは苦痛です

他のヒント

コンソールで＆quot; ri＆quot;を使用します

ri Date

これはすべてのクラスで機能します。 （例：ri String） 特定のメソッドのドキュメントを表示するには、これを使用します：

ri Date#yourMethod

Rubyドキュメントの標準的なソースは Ruby-doc です。関心があるのは、 core および標準ライブラリ。通常、引数の型と戻り値をカバーするjavadocスタイルの表現を取得します。 RDoc を使用して独自に作成することもできます。

バニラIRB内からドキュメントを必要とする人向け

  1. フォローこれらのコアRIの設定手順ドキュメンテーション。執筆時点での手順は次のとおりです

    $ cd ~/.rvm/src
$ rvm docs generate-ri

  2. ri コマンドを使用して、コマンドラインで特定のメソッドのドキュメントを表示できるようになりました。 IRB内から呼び出すには、ヘルプコマンドを使用します。

    $ irb
irb(main):001:0> help 'String#chomp'
ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top