Ruby コーティング規約について 命名規則編 2

はじめに

命名規則編 1 はこちらをクリック願います。
レイアウト編 3 はこちらをクリック願います。過去記事リンクあり。
構文編 2 はこちらをクリック願います。過去記事リンクあり。
Rubyの基礎を学習中の方に向けて記載致します。
私自身これからチーム開発を行う上で大事にしたい。知っておきたいことをOutputします。

命名規則について

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

qiita.rb

# 悪い例
:some_sym_1

some_var_1 = 1

var_10 = 10

def some_method_1
  # 処理
end



# 良い例
:some_sym1

some_var1 = 1

var10 = 10

def some_method1
  # 処理
end

② 述語メソッドに is、 does、 canのような助動詞をつけるべきではない。

• 冗長になるため。
• Rubyコアライブラリの述語メソッドのスタイル ( empty？や include？など)と矛盾するため。

qiita.rb

# 悪い例
class Person
  def is_buff?  #筋肉がある人？
    true
  end

  def can_play_rugbyfootball?
    false
  end

  def does_like_chocolate?
    true
  end
end



# 良い例
class Person
  def buff?
    true
  end

  def rugbyfootball_player?
    false
  end

  def likes_chocolate?
    true
  end
end

さいごに

毎日更新します。
皆様の復習等にご活用頂けますと幸いです。