こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。
この記事では、 Ruby on Railsの
- コントローラー
- テーブル
- モデル
などの命名規約をまとめた記事です。
テーブル定義規約については、以下の記事をご参考ください。
メソッド、変数の命名規約のまとめ
| 種類 | 書き方 | サンプル |
|---|---|---|
| メソッド | すべて小文字 スネークケースで記載 |
set_zip_code |
| 述語メソッド (※boolean値が返るメソッド) |
すべて小文字 スネークケースで記載 末尾が疑問符 |
is_exist? |
| 変数 | すべて小文字 スネークケースで記載 |
zip_code |
| 定数 | すべて大文字 スネークケースで記載 |
ZIP_CODE |
| シンボル | すべて小文字 スネークケースで記載 |
:zip_code |
コントローラーの命名規約のまとめ
| 種類 | 書き方 | サンプル |
|---|---|---|
| コントローラーのクラス名 | 各単語の1文字目のみ大文字で他はすべて小文字 キャメルケースで記載 末尾が「Controller」 |
HogeController |
| コントローラーのファイル名 | すべて小文字 スネークケースで記載 末尾が「_controller」 |
hoge_controller.rb |
モデルの命名規約のまとめ
| 種類 | 書き方 | サンプル |
|---|---|---|
| モデル名 | 1文字目のみ大文字で他はすべて小文字 スネークケースで記載 単数形にする |
Store |
| モデルのファイル名 | すべて小文字 スネークケースで記載 単数形にする |
store.rb |
| テーブル名 | すべて小文字 スネークケースで記載 複数形にする |
stores |
| マイグレーションファイル名 | yyyymmddhhmmss_create_「テーブル名」.rb | 20210408124217_create_stores.rb |
| マイグレーションクラス名 | Create「モデルを複数形」 | CreateStores |
まとめ：命名規約は覚えよう
以上がRuby on Railsの命名規約のまとめでした！
あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ
コメント