🪬
【Ruby超入門】命名規則
変数名やメソッド名などは、言語ごとにキャメルケースだったりスネークケースだったりと、名前のルールが慣習的に決まっているかと思います。
そこで今回は、Ruby ではどんな命名規則で名前をつけていくのかを紹介していきたいと思います。
キャメルケースやスネークケースがわからない方は以下の記事を見てください。
ファイル名、ディレクトリ名
- ファイルは末尾に「.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
クラス名、モジュール名
- UpperCamelCase(アッパーキャメルケース)で記述
- _(アンダースコア)は使わない
- 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
まとめ
以上が Ruby の命名規則でした。
変数名、メソッド名などの命名はとても重要なので、参考になれば幸いです。
Discussion