名前をつける時の命名規則ってどれ使うんだっけ?
rubyのプログラミングの勉強を始めたての方だと、変数名や関数名などの命名をどうすればいいか分からない...命名規則って何???って思う人が多いと思います。僕もそうでした。
プログラミングで使われる一般的な命名規則は5種類あります。
- スネークケース
アンダーバーで小文字の単語を繋げる
例:example_test - スクリーミングスネークケース
アンダーバーで大文字の単語を繋げる
例:EXAMPLE_TEST - キャメルケース
- ローワーキャメルケース (キャメルケース)
最初の単語の先頭を小文字に、2番目以降の単語の先頭を大文字にして繋げる
例:exampleTest - アッパーキャメルケース (パスカルケース)
単語の先頭を大文字にして繋げる
例:ExampleTest
- ローワーキャメルケース (キャメルケース)
- ケバブケース(ハイフンで小文字の単語を繋げる)
例:example-test
うーん、どれを使えばいいか分からん...
パッと見て、そう思った人がいるはず...
なので、場合ごとの命名方法を1分で分かるようにまとめてみました!
ぜひ活用してみてくださいね。
ファイル名 : スネークケース
ruby_sample.rb
ディレクトリ名 : スネークケース
ruby_sample/src/sample_calc.rb
変数名 : スネークケース
sample_a = 0;
メソッド名 : スネークケース
def sample_puts
puts 'hello!'
end
```ruby
## クラス名 : パスカルケース
class SamplePuts
def sample_puts
puts 'hello!'
end
end
## モジュール名 : パスカルケース
```ruby
module SamplePuts
def sample_puts
puts 'hello!'
end
end
定数名 : スクリーミングスネークケース
DEFAULT_SAMPLE = 0
[Tips] 真偽値を返すメソッド : メソッド名末尾に?をつける
def is_str_sample?(s)
s == 'sample'
end
[Tips] 破壊的メソッド : メソッド名末尾に!をつける
破壊的メソッドとは? : 呼び出したオブジェクトの状態が変更されてしまうメソッド
def str_upcase!(s)
s.upcase!
end
a = 'sample'
#変数aの値も変更されてしまう
b = str_upcase!(a) #=> "SAMPLE"
a #=> "SAMPLE"
まとめ
いかがでしょうか?
これで、どの場合にどの命名規則を使えばいいか迷うことはないはずです。
(※チームで開発している場合、プロジェクトのコード規約によって多少異なることがあるので、要確認!!)
忘れたとしてもこの記事を見れば大丈夫!
少しでもあなたの役に立てたのなら幸いです。
良いプログラミング生活を!!!