-命名規則が必要な理由-
-
命名を制限してプログラマの揺らぎを減らすため。
→開発者をあえて縛って、迷いにくく手間も少ない開発環境を実現するため。 -
名前から意味を把握するできるようにする。
→コードを読むのに文中に登録する要素の中身がある程度推測できれば、可読性をあげる。
Modelの命名規則
Model名
単数形で、
コード中 = キャメルケース
ファイル名 = スネークケース
になります(Rubyのクラス名の命名規則と同じ)。
キャメルケース
→単語の頭文字を大文字・それ以外を小文字で記述する表記法です。
例:Book
,MyName
など
スネークケース
→単語をすべて小文字にし、単語の区切りを_で記述する表記法です。
例:book
,my_name
など
Modelの属性名
キャメルケースで記述します。
ActiveRecordの予約語は避けてください。
例:type
など。
誤作動を起こす可能性があります。
制約ではありませんが、日時型の属性は_at
に命名するのが基本です。
属性名を見ただけで中身のデータ型が推測しやすくなります。
Viewの命名規則
ファイル名の命名規則は、
views/
の下にコントローラ名/
でディレクトリを作成して、その中にアクション名.html.拡張子
で表記します。
例:booksコントローラのindexアクションに対応するViewファイルを作成したい場合
→views/books/index.html.erb
Controllerの命名規則
基本的には複数形です。
必ず守る必要はありませんが、ルーティング周りの仕組みにおいても、コントローラ名が複数形である方が取り回しやすい作りになる。
最後に
ファイル名 = _controller
クラス名 = Controller
をつける必要があります。
例:books_controller
,BooksController