SNSでシェアする

Railsドキュメントのリファレンスの見方、読み方について 【初心者向け】

SNSでシェアする

スポンサーリンク
 
是非購読クリックお願いします☆

ruby_rails

railsでプログミングをされている方も、これから始めようと思っている方もrailsリファレンス(公式の参考サイト)の見方、読み方をしっかりと身につけておきましょう。

railsの全てのメソッドや、ヘルパーの記法を丸暗記している方は少ないと思います。

「あのメソッドなんだっけ…!?
 このrailsヘルパーのオプションの書き方ってどうだっけ…!?」

などと、ついつい忘れてしまうことも多いかと思います。

そこで役に立つのがrailsドキュメントのリファレンスですね。

ただ、”使い方”自体の説明が無く、結局どうやって書けばいいの!?
となってしまう方もいらっしゃるかと思います。(僕がそうでした)

プログラミングを始めたばかりの頃は、このリファレンスの見方について苦戦することもしばしば出てきます。

そこで簡単ではありますがrailsのリファレンスの見方、読み方をメモとして残しておきます。

スポンサーリンク

Railsドキュメントのリファレンスの「使い方」の見方、読み方

ここではRailsドキュメントのリファレンスの「使い方」の見方、読み方について解説していきます。

例としてrailsのヘルパーである「form_for」のリファレンスの見方について見ていきたいと思います。

railsでフォームを生成(form_for/form_tag)

このリファレンスを見てみると、使い方が以下のような形で説明されているかと思います。
form_for

赤色で囲ってある箇所にform_forの使い方が書いてあると思うのですが、最初のうちは、この”使い方”の使い方というか、見方、読み方がよくわかりません。。

「オプション!?はい?結局どうやって書くの?」
というような経験をされたこともあると思います。

これは”プログラミングあるある”ですが、どんな書籍や参考サイトもある程度知識が分かっている前提で説明も書かれているんですね。

これはもう仕方のないことなので、なんとか乗り越えていきましょう。。

このリファレンスにおいては、特に「オプション」の記法がイマイチわからないことが多いかと思います。

ここで一つ、覚えておいてください。

『railsのヘルパーメソッドのオプションは全てハッシュのキーバリューストアで書くことが決まり』

である、という事です。

今回のform_forのケースだと、使い方によれば、「第一引数にモデルオブジェクトを、第二引数には必要であればオプションも追加できますよ」と説明されているんですね。(オプションは必要に応じて付与する感じです)

第1引数はモデルオブジェクトなので、モデルクラスのインスタンスを渡してあげますね。
オプションを付与しない場合には以下のような形になります。

このform_forの記述に、さらにオプションを付与したい!という場合はどうすればいいでしょうか?

リファレンスを見てみると、form_forのオプションには以下のようなものが使えるようです。
form_for_option

また、以下のように使い方の例も書かれているので参考にしましょう。
ここで「urlオプション」という箇所に注目してください。
form_for_ example

ここで、先ほどの事を思い出してください。

『railsのヘルパーメソッドのオプションは全てハッシュのキーバリューストアで書くことが決まり』でしたね。

第一引数にはモデルオブジェクトである@userが、第二引数のオプションには以下のようにハッシュのキーバリューストアで書かれていることがわかります。

このようにrailsのヘルパーでオプションを付与する時はハッシュのキーバリューストアで記述すればいいという事がわかっていただけたのではないでしょうか。

まとめ

この記事の中でも書きましたが、プログラミングに関する書籍や参考サイトは最低限理解がある前提で書かれてある事がほとんどです。

初心者のうちは、こういう概念やニュアンスについて理解できず、挫折してしまいがちなんですよね。。

「誰でもわかるプログラミング」みたいな書籍ですら、初心者の頃、僕は読むことができませんでした。

初心者の壁を突破する、という意味ではプログラミングスクールに通うことも大事かと思います。

僕も実際にTECH::CAMPというプログラミングスクールに通い、初心者の壁を突破した一人です。

※ちなみに、その記事も以下に書いてあるので是非

TECH::CAMP(テックキャンプ)で変わった僕の人生観/感想/レビュー

ちなみにご連絡くれれば受講料安くなりますので是非お気軽にご連絡ください!
お問い合わせ

それでは、少しでもご参考になれたら幸いです!

もしよろしければ、是非、いいね!やシェア、ブックマーク等お願いします!!

スポンサーリンク
スポンサーリンク