ruby コードを書いていて、標準の Date 型を使用して現在の日付を取得したいとします。検索エンジンを使用する代わりに、このクラスのドキュメントをすばやく見つける方法はありますか? と入力して Date のメソッドを取得できることはわかっていますが、Date.methods
私が知る限り、引数の型や戻り値に関する詳細は提供されていません。
編集者固有の回答を歓迎します。私が選んだエディタは Emacs です。
ruby コードを書いていて、標準の Date 型を使用して現在の日付を取得したいとします。検索エンジンを使用する代わりに、このクラスのドキュメントをすばやく見つける方法はありますか? と入力して Date のメソッドを取得できることはわかっていますが、Date.methods
私が知る限り、引数の型や戻り値に関する詳細は提供されていません。
編集者固有の回答を歓迎します。私が選んだエディタは Emacs です。
ルビーコアドキュメントをブックマークします
Webブラウザのfind-textコマンドを使用します。
意外と思われるかもしれませんが、実際には、を使用するよりも高速であることがわかりました。これはri
、何らかの理由で起動するのに時間がかかるようです。
ri
また、HTMLページにすべてのメソッドのすべてのドキュメントが1つのページにリストされているため、はるかに優れています。多くの場合、メソッドは他のメソッドに関連しており、2のメソッドを切り替えるri
のは面倒です。
コンソールでは「ri」を使用します
ri Date
それはすべてのクラスで機能します。(例: ri String) 特定のメソッドのドキュメントを表示するには、次を使用します。
ri Date#yourMethod
Ruby ドキュメントの正規のソースはRuby-docです。そこにある最も興味深い 2 つのリンクはcoreとstandard libraryです。通常は引数の型と戻り値をカバーする javadoc スタイルの表現が得られます。RDocを使用して独自のものを作成することもできます。
バニラ IRB 内からドキュメントが必要な場合
コア RI ドキュメントを設定するには、次の手順に従ってください。執筆時点では、手順は次のとおりです。
$ cd ~/.rvm/src
$ rvm docs generate-ri
コマンドを使用して、コマンド ラインで特定のメソッドのドキュメントを表示できるようになりましたri
。IRB 内から呼び出すには、help コマンドを使用します。
$ irb
irb(main):001:0> help 'String#chomp'