📝

Rubyにおける複数単語での命名規則とRailsでのモデル名等の命名法則

2023/06/11に公開

今日はRubyで複数単語による命名を行うときの約束事と、それに絡むRailsでのモデル名・コントローラー名の法則性についてまとめたいと思います。

アッパーキャメルケースとスネークケース

複数単語による命名を行う際には、下記の2パターンが使われます。

  1. アッパーキャメルケース
    キャメルケースのパターンの1つで、先頭から単語の区切りを大文字で表します。
    例)ShippingFee
  2. スネークケース
    単語の区切りをアンダースコアで表します。
    例)shipping_fee

そして、Rubyにおいては下記のように使い分けがなされます。
アッパーキャメルケース ⇒ クラス名モジュール名
スネークケース ⇒ メソッド名変数名

Rails ではどのような命名になるのか?

Rubyでの命名規則にならって、Railsではモデル名やコントローラー名などがどのように命名されるのか、「ShippingFee」というモデルを作成した際の例をまとめます。

モデル 命名例
モデル名 ShippongFee
ファイル名 shipping_fee.rb
テーブル 命名例
テーブル名 shipping_fees
カラム名(外部キー) shipping_fee_id
コントローラー 命名例
コントローラー名 shipping_fee
ファイル名 shipping_fee_controller.rb

Discussion