【プログラミング入門】クラスや変数の命名規則をまとめてみた
導入
今回はJavaのお話
おそらく大抵の人は、
「そんなの知ってる」
「なに当たり前のことを言ってるのか」
という内容ですが、
先日、若手エンジニア同士の勉強会で
話題に挙がったので、備忘録も兼ねて
内容をまとめておきたいと思います
そもそも命名規則って?
命名規則とは、
開発をしていく上で実装するクラスやメソッド、変数などにつける
「名前の付け方」のこと
つまり、ルールのことです
どんな命名規則があるの?
- コンスタントケース(または、アッパーケース)
- パスカルケース(または、アッパーキャメルケース)
- キャメルケース(または、ローワーキャメルケース)
- スネークケース
- チェインケース(または、ケバブケース)
言語や組織によって、呼び方は色々あるみたいです。
一般的な呼び名ものは?
- キャメルケース
- パスカルケース
- スネークケース
- チェインケース
それぞれの特徴
名称 | 表記例 | 説明 | 主な用途 |
---|---|---|---|
パスカルケース | ItemSearchController | 先頭と要素語の先頭が大文字 | クラス |
キャメルケース | getItemInfo | 先頭だけ小文字で要素語の先頭は大文字 | メソッド、変数 |
スネークケース | user_id | アンダースコア(_)で単語を区切る | 定数や変数 |
チェインケース | modal-header | ハイフン(-)で単語を区切る | HTMLのidやclass |
コンスタントケース | INSTANCE_URL | すべて大文字 | 定数 |
所感
プログラミング歴が浅い人ほど
何気なく真似しながら開発してますが、
早い段階から命名規則を意識して開発すれば
変数名を見ただけでどんな用途なのか理解できるので
リーディングスキルが上がりそう
また、人によって読みやすさは違うと思うのですが
言語や開発チームによって、統一の仕方は違うので
基本的には、先人の慣習や流儀に従うのがいいですね