こんにちは！tenjiprogrammingです。
JavaScriptにおいて命名規則は非常に重要です。
適切な命名規則を使用することで、コードの可読性が向上しメンテナンスが容易になります。
この記事では、JavaScriptの命名規則について詳しく説明し、実際のコード例を使用して説明します。
命名規則
まずは命名規則にどのようなものがあるかを見ていきましょう！
ここでは代表的なものを紹介しますが、基本的にこれを知っていればどの言語でも大丈夫です。
キャメルケース
キャメルケースは、最初の単語を小文字で始め、次の単語からは大文字で始める命名規則です。
・”firstName“
・”lastName“
パスカルケース
パスカルケースは、全ての単語を大文字で始める命名規則です。
・”FirstName“
・”LastName”
スネークケース
スネークケースは、単語をアンダースコアで区切り、全ての単語を小文字で表記する命名規則です。
・”first_name“
・”last_name”
ケバブケース
ケバブケースは、単語をハイフンで区切り、全ての単語を小文字で表記する命名規則です。
・”first-name“
・”last-name”
これらの命名規則の中で、キャメルケースとスネークケースが最も一般的です。
キャメルケースはJavaScriptの慣例的な命名規則です。
スネークケースは他のプログラミング言語でもよく使用されます。
そして命名規則とは言いません(いう場合もある)が意味のある名前をつけることも非常に重要です。
一覧表
| キャメルケース | tanakaTaro |
| パスカルケース | TanakaTaro |
| スネークケース | tanaka_taro |
| ケバブケース | tanaka-taro |
命名規則の重要性
ではなぜ命名規則は重要なのでしょうか。
それは命名規則を適切に使用するとコードの可読性(読みやすさ)が向上し、メンテナンスが容易になるからです。
例えば、以下のようなコードがあるとします。
function add(a, b) { return a + b; }このコードでは、引数の”a”と”b”がどのような値であるか明確ではありません。
しかし、以下のような引数を適切に命名した場合はコードの意図が明確になります。
function add(num1, num2) { return num1 + num2; }こうすることで引数が”数字”であることが容易に伝わります。
これは簡単な例なのでありがたさがわからないかもしれませんが、複雑なプログラムになるととても重要です！
また一般的に実装はチーム(複数人)で行います。
そのため、自分で書いたコードが他の人が読んでもわかるようにしなければいけません。
チームで統一した命名規則を用いることでコードの可読性が向上します。
“a”や”abcd”のように意味のない文字の羅列にしてしまうと何を示しているのか分からなくなってしまう。
自分にも他人にも分かりやすいように！
JavaScriptの命名規則
ここからはJavaScriptという言語ではどのような命名規則が一般的に使われているのかを見ていきましょう!
変数名
変数名にはキャメルケースを使用することが一般的です。例えば、以下のように変数を宣言することができます。
let firstName = "John"; let lastName = "Doe";また、定数の場合は全ての単語を大文字で表記することが一般的です。
例えば、以下のように定数を宣言することができます。
const PI = 3.14;関数名
関数名にはキャメルケースを使用することが一般的です。例えば、以下のように関数を宣言することができます。
function calculateSum(num1, num2) { return num1 + num2; }クラス名
クラス名にはパスカルケースを使用することが一般的です。例えば、以下のようにクラスを宣言することができます。
class Person { constructor(firstName, lastName) { this.firstName = firstName; this.lastName = lastName; } }一覧表
| 命名規則 | |
|---|---|
| 変数名 | キャメルケース |
| 定数名 | すべての単語を大文字 |
| 関数名 | キャメルケース |
| クラス名 | パスカルケース |
まとめ
今回はJavaScriptの命名規則について紹介しました。
適切な命名規則を用いることでコードの可読性が向上し、バグが起こりにくくなります。
また、もしバグが発生してもコードのどこに問題があるのかを見つけることが容易になります。
命名規則を無視しているエンジニアを見かけることも多々あります…。
ただこの記事を読んでくれているあなたは命名規則を理解しているのでもう心配ありません！
プログラミング言語ごとに慣例的な命名規則は違うので適切な規則に従うことを意識しましょう。
当ブログではJavaScriptの練習問題も無料で公開しています。ぜひ解いてみてください！
NoteではPythonで作成したレトロなシューティングゲームのコードを全公開した記事を公開しています。
気になった方は見て頂けると励みになります。
コメント