コメントの書き方

コードは未来の自分への手紙でもある

「なぜここにこのコードを書いたのか」、1週間後には自分でも忘れます。チームで書いているなら、他の人はなおさらわかりません。

コメントを使うと、コードの中にメモを残せます。コンピューターはコメントを無視するので、プログラムの動きには影響しません。

コメントを実際に書いてみよう

1public class Main {
2  public static void main(String[] args) {
3      // ここから画面に表示する
4      System.out.println("Hello, World!");
5
6      /*
7        このプログラムは
8        Hello, World! と表示するだけです
9      */
10  }
11}

• // から行末までが1行コメント。その行だけ無効になる
• /* で始まり */ で終わる範囲が複数行コメント
• コメントはコンピューターに無視されるので、動きに影響しない
• 「何をしているか」ではなく「なぜそうしているか」を書くのがよいコメントの原則

コメントアウトで一時的に無効化する

行頭に // をつけると、コードを削除せず一時的に無効にできます。これをコメントアウトと呼びます。

1System.out.println("おはよう");
2// System.out.println("こんにちは"); ← 無効
3System.out.println("こんばんは");

「こんにちは」の行は実行されません。// を外すだけで元通りになるので、動作確認のときに便利です。

よくあるミス

/* */ の閉じる */ を忘れる

/* で始めたコメントは必ず */ で閉じます。閉じ忘れると、それ以降のコードもすべてコメント扱いになってエラーが出ます。/* を書いたらすぐに */ も書くのがおすすめです。