初めてプログラミングに触れる方や、経験者でも名前をつけることに迷うことはあります。
この記事では、エンジニアが知っておくべき命名方法について紹介します。 （初心者向け🔰）
1. 名前は具体的で簡潔に
関数や変数の名前はその目的や機能を明確に表すようにしましょう。適当な名前よりも、具体的で簡潔な名前が理解しやすく、保守もしやすいです。
例えば、関数名には動詞を使うと良いです。
-
calculateSum()- 合計を計算する -
printMessage()- メッセージを印刷する
2. 名前の長さと範囲
一般的に、変数や関数のスコープが広いほど、名前は長くて具体的にします。逆にスコープが狭い場合、名前は短くても大丈夫です。
例えば、ループ変数は i, j のように短く、一方で、グローバル変数は totalNumberOfUsers のように具体的にします。
3. 一貫性のある命名規則
プロジェクト全体で一貫性のある命名規則を使用することも重要です。これにより、他の開発者がコードを読む際に迷わないようにします。
例えば、一部ではキャメルケース(myVariable)を使用し、一部ではスネークケース(my_variable)を使用すると、混乱を招く可能性があります。
4. 略語を使わない
特に必要がなければ、略語は避けましょう。略語は作者にとっては理解しやすいかもしれませんが、他の開発者にとっては必ずしも明らかでないことがあります。
例えば、calcSum() ではなく、 calculateSum() のようにします。
命名はプログラミングの中でとても重要な要素です。はっきりとした名前をつけることで、他の開発者にコードの意図を伝え、バグを減らすことができます。