🟥
Ruby命名指針
概要
Ruby初心者がRubyの命名法について調べたので、まとめてみました。
随時更新予定。
命名関して
以下のように命名指針に従ってください。
-
メソッドの戻り値を変数に入れる場合、メソッド名と変数名の意味を合わせる
-
配列は複数形、ループ中の各要素は単数形(itemやelementは抽象度が高すぎるので使わないように)
-
dataやresult、input、infoも抽象度が高すぎて使わないように
-
メソッドやクラス名はそれだけで中でどんな処理をしているか分かるようにする
-
モデルの名前は名詞にする
-
二つの単語を繋げてモデルを作る場合は 形容詞 + 名詞 or 名詞 + 名詞にする
-
処理を実行するメソッドは 動詞のみ or 動詞 + 名詞にする
- Rubyの場合は真偽値を返すようなメソッドも「動詞で始めるルール」の対象外
- データの型を変換するようなメソッドでは、to_somethingのようなメソッド名もよく使う
- Railsの検証用メソッドなどでは、英文そのものをメソッド名にしてしまうケースもある
-
不可算名詞の使用は極力避けて工数を節約する(Railsの場合)
-
初心者のうちは名前を省略しない
-
長い名前を短くしたければ、省略例をライブラリ一覧で調べる
参考：
XユーザーのJunichi Ito (伊藤淳一)さん: 「プログラムの名前付け、実装を見に行かなくてもその名前見ただけで「たぶんこういうことをしてくれるんだろう」 / X
Discussion