はじめに
コードを書いていくうえで見やすいコードを意識していくのはエンジニアとして必須のこと。
よりわかりやすいコードを書いていくために必要とされる識別子の命名規則について少しまとめてみる。
キャメルケース
キャメルケースとは、複数の単語を組み合わせた識別子を表す際に、先頭の単語を小文字、それ以降の単語の最初の文字を大文字にして表記する命名規則のこと。
例えば、「firstName」「lastName」のように表記する。クラス名、メソッド名、変数名などに使用される。
Controller.php
// クラス名
class MyClass {
// プロパティ名
private $firstName;
// メソッド名
public function getLastName() {
// 変数名
$lastName = 'Smith';
return $lastName;
}
}
スネークケース
スネークケースとは、複数の単語を組み合わせた識別子を表す際に、アンダースコアを使って単語を区切って表記する命名規則。
例えば、「first_name」「last_name」のように表記する。主に変数名、関数名、定数名などに使用される。
Controller.php
// 変数名
$first_name = 'John';
// 定数名
define('LAST_NAME', 'Doe');
// 関数名
function get_full_name($first_name, $last_name) {
return $first_name . ' ' . $last_name;
}
ケバブケース
ケバブケースとは、複数の単語を組み合わせた識別子を表す際に、ハイフンを使って単語を区切って表記する命名規則。
例えば、「first-name」「last-name」のように表記する。主にHTML、CSSなどのWeb開発の分野で使用される。
Controller.php
// HTMLのclass属性
<div class="container-fluid">
<h1 class="text-center">Hello World</h1>
</div>
// CSSのセレクター名
.container-fluid {
background-color: #ffffff;
}
// JavaScriptの変数名
let first-name = 'John';
まとめ
これらの命名規則は、可読性や保守性を高めるために重要な役割を果たす。
また、プログラミング言語や開発環境、規約によっては、異なる命名規則が推奨されることがある。
よって、プロジェクトの規約に従って適切な命名規則を選択することが重要とのこと。
以上