【Ruby超入門】命名規則

【Ruby超入門】命名規則 Ruby / Rails

こんにちは！ゆきまさです！！（@yyykms）

変数名やメソッド名などは、言語ごとにキャメルケースだったりスネークケースだったりと、名前のルールが慣習的に決まっているかと思います。

そこで今回は、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の命名規則でした。

変数名、メソッド名などの命名はとても重要なので、参考になれば幸いです。

参考記事