【初心者向け】プログラミングで最初に覚えたい命名規則6選

【初心者向け】プログラミングで最初に覚えたい命名規則6選

変数やメソッドのネーミングが伝わりづらいと悩んでいませんか?
プログラミング初心者のうちは、何が良いネーミングなのか分からないですね。

プログラミングにおいてネーミングは非常に重要な行為です。ネーミングが悪いと他人が読んでも伝わらなかったり、自分でさえも理解できなくなってしまいます。

そんな悩みを解決するために、この記事ではプログラミング初心者が最初に覚えておきたい基本的な命名規則を6つ紹介いたします。

ネーミングには英語を使う

変数やメソッドに名前をつける場合は、シンプルな英語にしてください。プロの現場でも日本語で変数名をつける方が居ますが、英語と日本語が混じっていると統一感がなくなる上に読みづらいです。

×悪い例 : GetGazou
○良い例 : GetImage

また、日本語は複数形が使えないので、配列などをよく用いるプログラミング言語との相性もよくありません。

×悪い例 : GetGazousyu
○良い例 : GetImages

その上、日本語には同音意義語が多くありますので、単純に日本語をアルファベットにするだけでは誤解を招きます。例えば「Kaito」は解答と解凍の区別が付きません。

名前を大文字/小文字で区別しない

変数名をつける場合、大文字と小文字では別の変数として扱われますが、それらのみで区別される名前を使用することは厳禁です。例えばIdとidは、それぞれ別の変数名に使用することが可能ですが、こういった名前の重複は混乱の元になるので絶対に使用しないでください。

id1、id2などのように語尾に連番を使用するか、全く異なる名前を使用して変数を区別できるようにしましょう。

×悪い例
private string id;
private string ID;

○良い例
private string id1;
private string id2;

伝わりにくい省略形は使用しない

単語を省略する場合は、その単語の省略形が普及していて、他人が読んでも伝わる言葉に限定してください。

例えば、デザインやファッション業界ではblackをbkと略すことがありますが、万人が共通してbkをblackと認識できる訳ではありません。こういった単語の省略は控えてください。

×悪い例 : bk
○良い例 : black

しかし逆に、省略形の言葉が普及している場合は、積極的に省略形を使用し、コードの可読性を高めるように心がけましょう。

×悪い例 : personalComputer
○良い例 : pc

名前は長くても20文字以下にする

人が瞬時に認識できる文字は13文字までと言われています。プログラミングでも長すぎる名前は可読性を著しく落としてしまいます。名前は長くてもせいぜい20文字以下を目安にすることをおすすめします。

×悪い例 : getImageTemporary
○良い例 : getImgTmp

環境に応じた言葉を使う

例えばWindowsでいうところのフォルダは、Unixではディレクトリと呼びます。これらは同じ意味の言葉ですが、より命名規則に統一感を出すためにも、使用する環境に応じた名前をつけるように意識しましょう。

クラス名は重複の心配のない名前にする

SystemやMailなどのありふれた言葉をそのままクラス名にすると、規定で存在しているクラス名と衝突してしまう場合があります。クラス名には、重複の心配のないクラス名を付けるようにしましょう。

×悪い例 : Private Class Mail{}
○良い例 : Private Class EcMail{}

まとめ

いかがでしたでしょうか。復習すると命名規則において最初に覚えておきたい重要なことは以下の6つです。

  1. ネーミングには英語を使う
  2. 名前を大文字/小文字で区別しない
  3. 伝わりにくい省略形は使用しない
  4. 名前は長くても20文字以下にする
  5. 環境に応じた言葉を使う
  6. クラス名は重複の心配のない名前にする

この6つのポイントは、あらゆる言語において共通する最も基本的な原則なので、初心者の方は最初に覚えることをおすすめします。

コメントを残す

メールアドレスが公開されることはありません。