命名規則が慣習的に決まっていることが多かったのでまとめました。
以前自分がまとめたキャメルケースなどのブログも参考に。
ファイル名、ディレクトリ名
- ファイルは末尾に
.rbをつける - 全てを小文字にし、snake_case(スネークケース)で記述
- ファイル名：クラス名やモジュール名をsnake_caseに変更した名前を使用
- ディレクトリ名：モジュールの名前空間をsnake_caseに変更した名前を使用
# OK
# ファイル名
sample.rb
sample_ruby.rb
# ディレクトリ名
sample
sample_ruby
# NG
# ファイル名
Sample.rb
sample.ruby
sampleRuby.rb
# ディレクトリ名
Sample
SampleRuby
クラス名、モジュール名
- CamelCase(アッパーキャメルケース)で記述。(先頭も含めた単語の最初を大文字)
-
_(アンダースコア)は使わない -
HTTPやFTPなどの略語は大文字のまま
# OK
Sample
SampleRuby
FTPServer
# NG
sample
SAMPLERUBY
Sample_Ruby
変数名、メソッド名
- 全てを小文字にし、snake_case(スネークケース)で記述
- 配列は複数形で記述
# OK
sample
sample_ruby
# 配列
drinks
menbers
# NG
Sample
sampleRuby
定数
- SCREAMING_SNAKE_CASE(スクリーミングスネークケース)で記述
# OK
SAMPLE
SAMPLE_RUBY
# NG
sample
SampleRuby