Rails ドキュメントの探し方

Question

Rails の Time.zone の中にどんなメンバーがあるのか
どんな関数があるのか調べたいのですが

php のマニュアル http://php.net/manual/ja/
Java のAPIドキュメント https://docs.oracle.com/javase/jp/8/docs/api/

みたいな使用できるメソッド一覧みたいな日本語ドキュメントはどこにあるのでしょうか

Answer 1

Railsには日本語のAPIリファレンスはありませんので、そのへんは割り切ってください。
ドキュメントとしては、公式サイトのAPIのリンクを押して検索するのが王道です。
とりあえず関連リンクを書いておきますね。

公式サイト
https://api.rubyonrails.org/

APIリファレンス
https://api.rubyonrails.org/

ざっくりしたガイドについては日本語化されたものがありますが、ドキュメントではありません。
https://railsguides.jp/

Time.zoneについて調べたければ、APIリファレンスの検索窓に「Time」を入れて検索し、zoneについての情報を探していくという感じですね。
https://api.rubyonrails.org/

Comments

[退会済みユーザー]

日本語はないんですね…

ためしに
Activesupport の Time を調べようとしたんですが time.rb のページをたどっても

Required Files
date
time
active_support/core_ext/time
active_support/core_ext/date
active_support/core_ext/date_time
active_support/core_ext/integer/time
active_support/core_ext/numeric/time
active_support/core_ext/string/conversions
active_support/core_ext/string/zones

とかかれてるだけでリンクも何もなく何がなんだかわからず途方にくれてました…

クラスの中には
CLASS ActiveSupport::TimeWithZone
CLASS ActiveSupport::TimeZone
はあるのですがTimeはないみたいで…

[mingos]

https://api.rubyonrails.org/ に行き、左上の検索窓にTimeと入れてエンターを押します。
すると左にTimeに一致するクラスなどが表示されます。
ここからは勘になりますが、タイムゾーンの一覧を知りたいのでActiveSupport::TimeZoneが怪しいと思ってクリックします。
右側に表示されたページをスクロールしていくと、Constants ＞ MAPPINGのところにずらずらとタイムゾーンの名前っぽいのがあるので、まぁこれだろうなと考える。
みたいな感じで、ある程度試行錯誤するしかないですね。

[mingos]

まぁ、リファレンスが分かりづらいのは仕方ないので頑張るしかありません・・・。
本末転倒ですがGoogle検索してブログ記事などを見るなどもありです。
ただ個人のブログは筆者の勘違いや間違いも含まれるため、鵜呑みにせず自分で検証するなどは必要ですけども。

例えば、こちらの記事なんかはAPIリファレンスを読んでも絶対に分からない内容です。

RubyとRailsにおけるTime, Date, DateTime, TimeWithZoneの違い - Qiita
https://qiita.com/jnchito/items/cae89ee43c30f5d6fa2c

やはり、ある程度時間をかけてRailsを使っていきながら、経験を積んで知識を蓄えるしかないような事はたくさんあるような気がします。
他の言語、フレームワークも同様かと思います。

[退会済みユーザー]

いつもはブログ記事から検索するのですが
今回はこの中にどんな情報が入っているかをしる必要があったので
網羅的に紹介してくれてる記事がみつからなかったので仕方なくマニュアルをみにいこうとしてました

>ここからは勘になりますが、タイムゾーンの一覧を知りたいのでActiveSupport::TimeZoneが怪しいと思ってクリックします。
ということは ActiveSupport の Time.zone を使っていてもそのクラスが何なのかをピンポイントで調べる方法はないということですか…

[mingos]

はい、そうですね。

リファレンスで名前だけで探すのは難しいと思います。
たとえば、RubyMineなどのIDEを使っているのであれば、
コード中のTime.zoneと書いてある行のzoneのところをクリックして定義まで移動する事が出来ますので、そこで何のクラスなのかを絞り込んで、
その後リファレンスを参照するといった形を取るほうがいいかもしれません。

[退会済みユーザー]

なるほどです
非常に丁寧にありがとうございました