【Ruby on Rails】railsで使用する言語の命名規則まとめ

railsはHTML/CSS、Ruby、JavaScriptを主に使用しますが、それぞれの命名規則を毎回忘れてしまうのでまとめてみました。

ネットで公開されているコーティング規則を参考にしています。

業務では命名規則などは決まっていると思うので、独学者の人の参考になればと思います。

命名規則　なんとかケース

〇〇ケースについてまとめてある記事があったので、わからない人は参考にしてください。

命名規則まとめ：https://qiita.com/deerboy/items/f035b9044edf9a51aff7

Ruby on Rails

モデル

モデル名は単数形にする。

データベースのテーブル名はモデルクラスを複数形にしたもの。

コントローラー

コントローラー名はモデルクラスを複数形にしたもの。

場合によっては単数形にできる。

ビュー

ビューのディレクトリ名はコントローラー名と同じ。

ディレクトリ、ファイル

rails全体の命名規則

モデル・コントローラー・ビューのファイル名の命名規則と同じ。
スネークケースで記述。

foo.rb
foo_bar.rb

名前空間

ディレクトリを使用して階層構造で表現をする。
コントローラーとビューが関係する。

参考：現場で使えるRubyonRails5 速習ガイド

Ruby

クラス・モジュール

アッパーキャメルケースで記述。
ただし、HTTPなどの略語の場合はすべて大文字のままとする。

ExampleClass
HTTPClient

メソッド

スネークケースで記述。
メソッ ド名には動詞の原形を使用する。

add_something

変数

スネークケースで記述。

tmp
local_variable
@instance_variable

定数

スクリーミングスネークケースで記述。

EXAMPLE_CONSTANT

参考：https://shugo.net/ruby-codeconv/codeconv.html

HTML/CSS

クラス名

ケバブケースで記述。

<div class="md-accent"></div>

ID名

ケバブケースで記述。

<div id="user-profile"></div>

JavaScriptで使用するID名は最初の単語にjsとつけると、わかりやすくなる。(個人的感想)

<div id="js-user-profile"></div>

参考：https://google.github.io/styleguide/htmlcssguide.html

JavaScript

関数

ローワーキャメルケースで記述。
動詞または動詞＋名詞となるように命名する

create
createImage

変数

ローワーキャメルケースで記述。

test
sampleImage

定数

スクリーミングスネークケースで記述。

TEST
SAMPLE_IMAGE

参考：https://google.github.io/styleguide/javascriptguide.xml

まとめ

個人的なまとめなので、賛否両論はあると思いますが、誰かの参考になればと思います。