命名規則の使い分け

はじめに

みなさんこんにちは、あるいはこんばんは。Conte です。
普段何気なくつけている変数名や関数名。ですが、プロジェクトが進むにつれて、その重要性に気付くことはありませんか？ 今回は、開発の効率化やコードの可読性を高めるための命名規則についてまとめました。少しの工夫で、未来の自分やチームメンバが開発しやすいプロジェクトになるかもしれません。
また、Javaを使用したWEBアプリケーションでの利用例とともに、見てきます。(フロント・バック・DB含む)。
※ 用途はあくまで一例デス。PJにより使い分けて下さい。

キャメルケース・ローワーキャメルケース

• 単語の先頭を大文字で繋げる
• 先頭は小文字

用途

• メソッド名
• 変数名

例

- isFirstName
- getName
- setName

パスカルケース・アッパーキャメルケース

• 単語の先頭を大文字で繋げる
• 先頭は大文字

例

- UserName
- UserController

用途

• クラス名

スネークケース・ローワースネークケース

• 単語の先頭をアンダーバーで繋げる
• 全て小文字

例

- user_id
- user_name

用途

• DBのテーブル名
• DBのカラム名

コンスタントケース・アッパースネークケース

• 単語の先頭をアンダーバーで繋げる
• 全て大文字

例

- DATE_FORMAT
- ADMIN_ROLE

用途

• 定数宣言

ケバブケース・ローワーケバブケース・チェインケース

• 単語の先頭をハイフンで繋げる
• 全て小文字

例

- user-name
- user-password

用途

• HTMLの要素名 (タグ名など)
• HTMLの属性名 （クラス名など）

最後に筆者からの命名アドバイス

単語は略して書かないことをお勧めします。自分だけ分かれば良いのは個人開発までです。
新規参画者のことを考えましょう。

例

• CD -> Code
• DT -> Date