1.1　はじめに

　この章では、あなたが書くプログラムを他の人にも簡単に理解してもらえるようにする、変数名とメソッド名の付け方を学びます。わかりやすい名前を使うと、プログラムの各部分が何をしているのかが一目でわかります。ここでは、いい名前を考えるコツを紹介します。

1.2　わかりやすい名前をつける

　変数やメソッドの名前は、それが何をするのかが一目でわかるようにしましょう。名前が明確だと、コードを書くときに間違えにくくなります。誰が見ても、すぐに「このコードは何をしているんだろう？」と理解できるので、コードを共有したり、一緒に作業するときに役立ちます。逆に、名前がわかりにくいと、他の人があなたのコードを見たときに、「これは何なんだろう？」と困ってしまいます。そのため、シンプルで直感的にわかる名前をつけることは、コードを使いやすくするために重要なポイントです。

リスト1.1: 変数名tsは、変数名totalScoreよりも意味がわかりにくい

int ts; // どういう意味かよくわからない名前（totalScoreの略かもしれないけど、よくわからない）
  int totalScore; // 意味のある名前（スコアの合計点数）

1.3　名前のつけ方のルール

　プログラミングでは、名前をつけるときのルールがあります。これを 「命名規則」と呼びます。よく使われる命名規則には、次のようなものがあります。

　・パスカルケース（PascalCase）：単語の最初の文字を大文字にします。

　・キャメルケース（camelCase）：最初の単語以外の単語の最初の文字を大文字にします。

　・スネークケース（snake_case）：単語をアンダースコア（_）でつなぎ、全部小文字で書きます。

　・アッパースネークケース（UPPER_SNAKE_CASE）：単語をアンダースコアでつなぎ、全部大文字で書きます。

　C#では、次のような命名規則がよく使われます。

　・クラス名やメソッド名：パスカルケース（PascalCase）

　　─例：public class MyClassName {};

　・変数名：キャメルケース（camelCase）

　　─例：private int myVariable;

　C#の命名規則については、Microsoft Learn名前付けのガイドラインがとても参考になるので、ぜひご覧ください。¹

1.4　略語と頭字語の使い方

　プログラムを書くとき、略語や頭字語を使うことがあります。よく知られている略語なら、他の人にも意味が伝わりやすいです。でも、あまり知られていない略語を使うと、コードが読みにくくなってしまうことがあるので気を付けましょう。

　・いい例：http - ハイパーテキスト転送プロトコル（Hyper Text Transfer Protocol）の略です。多くの人が知っているので使っても問題ないでしょう。

　・悪い例：usrNm - 「ユーザーネーム（UserName）」を省略したものですが、このような略し方は避けた方がいいです。

1.5　数字だけで意味を表さない

　「マジックナンバー」と呼ばれるものがあります。これは、コードの中で意味がわかりにくい数字をそのまま使うことをいいます。「なんでこの数字なの？」と他の人が疑問に思ってしまうので、なるべく避けましょう。代わりに、その数字が何を意味しているのかが、わかる変数名を使うといいでしょう。そうすれば、コードが何をしているのかがはっきりして、あとで数字を変更するときも楽になります。

　たとえば、こんなコードがあったとします。

リスト1.2: マジックナンバーを使った例

if (score > 80) {
      // 点数が80より高かったときの処理
  }

　この80が何を表しているのかは、ぱっと見ただけではわかりません。これを改善するには、次のようにします。

リスト1.3: 数字の意味がわかる変数名を使った例

const int PassingScore = 80;
  if (score > PassingScore) {
      // 点数が合格点より高かったときの処理
  }

　このようにPassingScoreという変数名を使うことで、「80」が「合格点」という意味だとわかるようになり、コードが読みやすくなります。

1.6　名前の長さはほどほどに

　変数の名前は、長すぎても短すぎてもいけません。ちょうどいい長さを考えることが大切です。長すぎると読みにくいコードになりますし、短すぎると何のことだかわからなくなってしまいます。そのため、名前はなるべく簡潔に、でも意味がはっきり伝わるようにしましょう。

　・長すぎてダメな例：numberOfElementsInList - 長すぎると読むのが大変です。

　・短すぎてダメな例：n - 短すぎると何の変数かわかりません。

　・ちょうどいい例：elementCount - 短くてもしっかりと意味が伝わります。

1.7　「I」は「インターフェイス」の印

　C#のルールとして、インターフェイスには必ず「I」をつけます。「I」は「インターフェイス（Interface）」の頭文字です。これを見れば、「あ、これはインターフェイスなんだな」とすぐわかるようになっています。

リスト1.4: インターフェイスの書き方

public interface IShape
  {
      void Draw();
      double Area();
  }

  public interface IResizable
  {
      void Resize(double size);
  }

インターフェイスってなに？

　プログラミングの世界では、「インターフェイス」というものがあります。インターフェイスは、クラスの設計図のようなものです。インターフェイスには、クラスが持つべきメソッドの名前だけが書かれていて、その中身は書かれていません。インターフェイスを使うことで、複数のクラスに共通の機能を持たせることができます。

　たとえば、「図形」というインターフェイスがあったとします。このインターフェイスには、「面積を計算する」というメソッドと、「描画する」というメソッドが定義されています。そして、「円」クラスと「四角形」クラスがこの「図形」インターフェイスを実装しているとします。すると、「円」クラスと「四角形」クラスには、必ず「面積を計算する」メソッドと「描画する」メソッドが存在することになります。

　このように、インターフェイスを使うことで、共通の機能を持つクラスを作ることができるのです。C#では、インターフェイスの名前は「I」から始めるというルールがあります。

1.8　ドリル問題

ドリル1：わかりやすい名前をつける

問題

　あなたは、学校の生徒の数を管理するプログラムを作っています。次の変数名をわかりやすくして、何を表しているのかはっきりさせてください。

リスト1.5: ドリル1：わかりやすい名前をつける

int a = 5; // 生徒の数

ヒント

　生徒は英語で「student」、数は英語で「count」といいます。

答え

　101ページを参照してください。

ドリル2：命名規則を守る

問題

　ネットショッピングのサイトで、ユーザーの数と注文の合計金額を表す変数名が次のようになっています。C#の命名規則に合うように直してください。

リスト1.6: ドリル2：命名規則を守る

private int userCount = 5;
  private int OrderTotal = 100;

ヒント

　C#では、プライベート変数（private）はキャメルケース（camelCase）を使います。

答え

　101ページを参照してください。

ドリル3：略語に気を付ける

問題

　会社の社員情報を管理するプログラムです。次の変数名をもっとわかりやすくして、むやみに短くしないように直してください。

リスト1.7: ドリル3：略語に気を付ける

string empNm = "Hanako";

ヒント

　社員は英語で「employee」、名前は英語で「name」といいます。

答え

　101ページを参照してください。

ドリル4：マジックナンバーを使わない

問題

　ゲームでプレイヤーがダメージを受ける処理が、次のようになっています。マジックナンバーを使わないで、変数を使ってわかりやすくしてください。

リスト1.8: ドリル4：マジックナンバーを使わない

public void Damage(){  // ダメージを受けるメソッド
      hp -= 3;  // プレイヤーのHP（体力）を3減らす
  }

ヒント

　ダメージは英語で「damage」といいます。

答え

　101ページを参照してください。

ドリル5：名前の長さに気を付ける

問題

　お店の商品を管理するプログラムです。次の長すぎる変数名を改善して、読みやすくしてください。

リスト1.9: ドリル5：名前の長さに気を付ける

int theTotalNumberOfProductsInInventory = 150; // 在庫にある商品の数

ヒント

　「theTotalNumberOf」の部分が長すぎる原因になっています。数を表す別の英単語は何でしょうか。

答え

　102ページを参照してください。

ドリル6：インターフェイスに「I」をつける

問題

　ゲームのプログラムで、PlayerクラスとEnemyクラスを作りました。このふたつのクラスは、どちらもHumanインターフェイスを実装しています。しかし、インターフェイスの名前がC#のルールに合っていません。「I」をつけて直してください。

リスト1.10: ドリル6：インターフェイスに「I」をつける

public interface Human
  {
      void Resize(double size);
  }

ヒント

　C#のルールでは、インターフェイスの名前には必ず「I」をつけます。

答え

　102ページを参照してください。

1.9　この章のまとめ

　この章では、プログラムを読みやすくするために、変数やメソッドの名前の付け方について学びました。最初は名前を考えるのに時間がかかるかもしれません。でも、はっきりした名前をつけることで、プログラムが何をしているのかがわかりやすくなります。とくに、他の人とプログラムを共有するときや、あとで自分が書いたプログラムを見直すときに、わかりやすい名前はとても役立ちます。

　ここで紹介したポイントをまとめておきましょう。

　・わかりやすい名前をつける：見ただけで意味が伝わる名前を選びましょう。そうすれば、混乱せずにプログラムの内容が理解できます。

　・ルールを守る：決まったルールで名前をつけることで、プログラムの中で名前の役割がすぐわかるようになります。

　・略語は慎重に：みんなが知っている略語はOKですが、わかりにくい略語は混乱のもとになるので避けましょう。

　・マジックナンバーは使わない：数字をそのまま書くのではなく、その数字が何を意味しているのかが、わかる名前をつけましょう。

　・名前の長さはほどほどに：長すぎても短すぎても望ましくありません。ちょうどいい長さで、意味がきちんと伝わる名前を考えましょう。

　・インターフェイスは「I」で始める： C# では、インターフェイスの名前の最初には必ず「I」をつけます。これを見れば「インターフェイスだな」とすぐわかります。

　これらのコツを意識すれば、あなたのプログラムはもっとわかりやすくて、読みやすくなります。つよいプログラマーになるために、基本となる変数とメソッドの名前の付け方でした。次の章も一緒に勉強していきましょう。