Rubyにおける命名規則（命名規約）とは【初心者向け】

Rubyにおける命名規則（命名規約）について解説します。

 
そもそもRubyについてよく分からないという方は、Rubyとは何なのか解説した記事を読むとさらに理解が深まります。

なお本記事は、TechAcademyのオンラインブートキャンプRuby講座の内容をもとに紹介しています。

 

 

命名規則（命名規約）とは

命名規則とは、プログラミングで、変数、型、関数などに名前を付ける際のルールや慣習のことです。

命名規則が無い場合と比較し、命名規則を定めることは以下のような利点があります。
– 名前が役割や意味を表現するので、ソースコードを読解する労力を削減できる。
– ソースコードレビューの際に、文法や命名規則についての議論が不要になり、本質的な部分に集中できる。

プログラミング言語そのものが命名規則を定義(推奨)している場合もあります。
また、所属している会社や、参加しているプロジェクトで、命名規則を定めている場合もあります。

 

命名規則（命名規約）の例

インターネット上で、Rubyのコーディング規約が多数公開されています。

有名なものを3つ取り上げます。

• Rubyスタイルガイド
• Rubyアソシエーションのコーディング規約集
• Ruby コーディング規準

これらは、命名規則だけでなく、インデントの仕方やコメントの入れ方など、Rubyのコーディング全般に触れています。

ここでは、上記の「Rubyスタイルガイド」より、命名規則を抜粋します。

 

シンボル、メソッド、変数にはsnake_caseを用いる

snake_caseとは英小文字の単語を_(アンダースコア)で区切り連結する方法です。

# 良い例
today_weather = 'sunny'

# 悪い例
todayweather = 'sunny'
TodayWeather = 'sunny'

 

シンボル、メソッド、および変数名において、文字と数字を分離しない

文字に続けて(アンダースコアを入れずに)数字を入れます。

# 良い例
var0 = 0

# 悪い例
var_0 = 0

 

クラスやモジュールにはCamelCaseを用いる

CameCaseとは、単語の先頭を大文字にし、単語の区切りを示す方法です。

# 良い例
class MyClass
end

# 悪い例
class my_class
end

 

定数はSCREAMING_SNAKE_CASEを用いる

snake_caseで、かつ全て大文字にする表記です。

# 良い例
CIRCLE_RATIO = 3.14

# 悪い例
CircleRatio = 3.14

 

述語メソッド(boolean値が返るメソッド)は疑問符で終わる

述語メソッドとはオブジェクトが特定の状態かどうか、true/falseを返すメソッドです。

例えば、Arrayクラスのempty?メソッドは、配列が空の場合にtrueを返します。

# 良い例
class Person
  def tall?
    # 実装
  end
end

# 悪い例
class Person
  def tall
    # 実装
  end
end

 

危険な可能性のあるメソッドは感嘆符で終わる

ここでの危険とは、破壊的な(不可逆な)変更を行うかどうかです。

例えばArrayクラスのreverse!メソッドは、配列そのものを逆転させるため、感嘆符付きになっています。

一方、reverseメソッドは、配列そのものを変更せず、逆転した配列を戻り値とするため、感嘆符なしです。

# 良い例
class MyClass
  def update!
    # 実装
  end
end

# 悪い例
class MyClass
  def update
    # 実装
  end
end

 

[PR] Rubyのプログラミングで挫折しない学習方法を動画で公開中

監修してくれたメンター

橋本紘希 システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

 

TechAcademyでは、初心者でもRuby on Railsを使ったプログラミングを習得できるオンラインブートキャンプRuby講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。