筆者が個人的に使っている命名規約は以下のとおりです。
基本的に、命名記法とスコープ記法から成り立ちます。
命名記法
命名の型 | 記法 | 例 | 利点 |
---|---|---|---|
変数 | スネーク記法 | num_max | 読みやすい |
関数 | キャメル記法 | getNum | 強固さの印象から、ロジックを連想しやすい |
クラス | Pascal記法 | BusinessPerson | もっとも強固であるから、オブジェクトを連想しやすい |
スネーク記法
単語間をアンダーバーで繋ぐ
基本的に小文字
キャメル記法
先頭は小文字。
以降単語の頭文字は大文字。
アンダーバーは使用しない。
Pascal記法
基本的にはキャメルと類似。
ただし先頭は大文字。
スコープ記法
スコープ | 記述 | 例 | 利点 |
---|---|---|---|
パブリック | (特になし) | num_max | ユーザーに開示されるため、影響が大きい |
プライベート | 命名の最後尾にアンダーバー | num_max_ | 開発にのみ影響が出ることを示す。 |
ローカル | 命名の先頭にアンダーバー | _num_max | 変数管理による、影響が少ないイメージをまず与える |
基本的に、アンダーバーが多くなると、
柔らかい = フレキシブルな印象を与えています。