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

はじめに

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

命名規則について

① シンボル、メソッド、変数にはsnake_caseを使う。

qiita.rb

# 悪い例
:'some symbol'
:SomeSymbol
:someSymbol

someVar = 3

def someMethod
  # 処理

end

def SomeMethod
  # 処理
end


# 良い例
:some_symbol

some_var = 3

def some_method
  # 処理
end

② クラスやモジュールにはCamelCaseを使う。

qiita.rb

# 悪い例
class Someclass
  # 処理
end

class Some_Class
  # 処理
end

class SomeXml
  # 処理
end

class XmlSomething
  # 処理
end



# 良い例
class SomeClass
  # 処理
end

class SomeXML
  # 処理
end

class XMLSomething
  # 処理
end

③ ファイル名にはsnake_caseを使う。例）hello_qiita.rb

④ ディレクトリ名にはsnake_caseを使う。例）Add/hello_qiita.rb
　　→　早速、GitHubで使ってみます。

さいごに

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