Railsの命名規則まとめ

スポンサーリンク

はじめに

Railsにおける命名規則を忘れがちなので、まとめます。
大まかな理解はしていても意外と抜けてしまってエラーが出てしまいますよね・・・
特に複数単語のときにキャメルケースなのか、スネークケースなのかをよく間違えてしまうので、備忘録として残しておきます!

キャメルケース、スネークケースとは

端的にいうと、名前の区切りをどのようにつけるかの違いです。
プログラミングはスペースを入れることが次のオプションを指し示したりするので容易に次の単語を表すことができません。
全部小文字だとどこが切れ目かわかりにくいので、相手に伝えやすくする方法として生まれました。下記が具体的な書き方です。

名称書き方解説
キャメル名SuperEngineer単語ごとに大文字で始める
スネーク名super_engineer単語ごとの区切りを_で記述する。

コントローラーの命名規則

単一単語

名称書き方解説
コントローラー名example先頭小文字・単数形
コントローラークラス名ExamplesController先頭小文字・複数形・キャメルケース
ファイル名examples_controller.eb先頭小文字・複数形・スネークケース

複数単語

名称書き方解説
コントローラー名super_engineer自分が書いたやつ・スネークケース
コントローラークラス名SuperEngineerController自分が書いたやつ・キャメルケース
ファイル名super_engineer_controller.eb自分が書いたやつ・スネークケース

rails generateコマンドでの書き方

rails generateコマンドには、キャメルケースでもスネークケースでもどちらでも大丈夫です!
最初は不安になりますが、作成して間違った名前だと思ったらすぐ削除すればいいのでめちゃくちゃ神経質になる必要はないです。

#ターミナル
# 作成
rails g controller super_engineer
rails g controller SuperEngineer

# 削除
rails d controller super_engineer
rails d controller SuperEngineer

モデルの命名規則

単一単語

名称書き方解説
モデル名example先頭小文字・単数形
モデルクラス名Example先頭大文字・単数形
ファイル名example.eb先頭小文字・単数形
テーブル名examples先頭小文字・複数形

複数単語

名称書き方解説
モデル名super_engineer先頭小文字・単数形・スネークケース
モデルクラス名SuperEngineer先頭大文字・単数形・キャメルケース
ファイル名super_engineer.eb先頭小文字・単数形・スネークケース
テーブル名super_engineers先頭小文字・複数形・スネークケース

rails generateコマンドでの書き方

# ターミナル
rails g model SuperEngineer

終わりに

基礎中の基礎ですし、初学者の方にとって最初から複数単語必要なコントローラーやモデルは作らないと思いますので覚える必要はないかなと思います。
けど、自分のRailsでアプリを作りたい人にとっては意外とバンバンぶつかって忘れてしまい検索に時間を取られてしまうことがあるので要注意ですね。
ぜひブックマークしてみてください!

タイトルとURLをコピーしました