命名規則について

目的

• 自分の中で若干不明瞭な命名規則についてまとめる。
• 自分の命名規則が曖昧すぎてコードの品質が悪いので正しい使用用途をまとめる。

キャメルケース(camelCase)

• 単語の頭文字を大文字にする。
• 全ての単語の頭文字を大文字にするものをアッパーキャメルケース(パスカルケース)という。(例: FirstName)クラス名で使用する。
• 最初の単語の頭文字を大文字にしないものをローワーキャメルケースという。(例: firstName)インスタンス化した変数や関数で使用する。

スネークケース(snake_case)

• 単語と単語の間にアンダーバーを入れる。(例: first_name)データベース系で使用する。
• 全ての英字を大文字にするものをコンスタントケースという。(例: FIRST_NAME)定数やグローバル変数など特別な値を格納する変数名などに使用する。

ケバブケース(kebab-case)

• 単語と単語の間にハイフンを入れる。(例: first-name)
• HTMLの属性やクラスの命名時に使用する。

前述の内容のまとめ

• アッパーキャメルケースはクラス名で使用する。
• ローワーキャメルケースはインスタンス化した変数や関数で使用する。
• スネークケースはデータベース系の内容で使用する。
• コンスタンスケースは定数やグローバル変数など特別な変数で使用する。
• ケバブケースはHTMLの属性やクラス命名時に使用する。

大切だと感じること

• 各ケースのルールを混成して命名しない。
• 変数なら格納される値や使用用途によって命名規則を使い分ける必要がある。
• 命名規則をうまく使い分け、可読性の高いコードを心がけよう。

参考にしたサイト

• https://html-coding.co.jp/knowhow/tips/naming-rule/