命名規約パーフェクトガイド(個人的)：主要なスタイルと実践例
はじめに
いろいろな言語を扱うと毎回わからなくなりませんか？
定年退職後の備忘録としてまとめたものです。
コーディングにおける命名規約は、コードの可読性を高め、チーム開発をスムーズに進める上で不可欠です。この記事では、プログラミングで頻繁に目にする主要な命名スタイルを、具体的な例を交えながら解説します。
1. キャメルケース (Camel Case)
単語の先頭を大文字にして連結する規約です。ラクダのこぶのように見えることから名付けられました。
アッパーキャメルケース (Upper Camel Case)
-
例:
MyClassName,HttpRequest - 主な用途: クラス名、インターフェース名
- 主な採用言語: Java, C#, C++, PHP
ローワーキャメルケース (Lower Camel Case)
-
例:
myVariableName,getFirstName - 主な用途: 変数名、関数名、メソッド名
- 主な採用言語: Java, JavaScript, C++, PHP
2. スネークケース (Snake Case)
単語をアンダースコア（_）で区切る規約です。ヘビのように見えることから名付けられました。
ローワースネークケース (Lower Snake Case)
-
例:
my_variable_name,calculate_total_price - 主な用途: 変数名、関数名、モジュール名
- 主な採用言語: Python, Ruby, Perl, PHP
アッパースネークケース (Upper Snake Case)
-
例:
MY_CONSTANT_VALUE,MAX_USERS - 主な用途: 定数
- 主な採用言語: Python, Ruby, PHP
3. ケバブケース (Kebab Case)
単語をハイフン（-）で区切る規約です。
-
例:
my-component-name,blog-post-title - 主な用途: URL、CSSのセレクター名、HTMLのデータ属性
- 主な採用言語: CSS, URL, HTML
4. パスカルケース (Pascal Case)
キャメルケースのアッパーキャメルケースと全く同じです。MyClassNameのように、すべての単語の先頭を大文字にします。
-
例:
UserAccount,LoginService - 主な用途: クラス名
- 主な採用言語: C#, C++
命名規約の選び方とベストプラクティス
- 言語の慣習に従う: 各言語には、独自の推奨される命名規約があります。PythonのPEP 8などを確認し、それに従いましょう。
- チーム内で統一する: チームで開発を行う場合、特定の命名規約を事前に決め、全員がそれに従うことが重要です。
- 規約に固執しすぎない: 規約はあくまでガイドラインです。コードの意図がより明確になるのであれば、柔軟に判断することも大切です。
これらの命名規約を適切に使いこなすことで、あなたのコードは誰にとっても読みやすく、メンテナンスしやすいものになります。ぜひ、今日から実践してみてください。