手を動かして学ぶ Java入門 (コメントの書き方)

環境構築不要！　ブラウザから直接コードを実行できます。
本記事では、Java のコメントの書き方を学びます。

１０分くらいで、さくっと終わる記事をめざしています。

シリーズ一覧

続きは近日公開予定！

はじめに

この記事は paiza.IO の「Online Java compiler」を利用しています。
2024/9/13 現在、上記環境の Java バージョンは 18 です。(paiza.IO利用ガイド)

実行したコードは paiza.IO で保存および公開されることがあります。
そのため、個人情報などの機密性の高い情報は、コードとして入力しないようにご注意ください。

詳細は paiza.IO の利用規約およびプライバシーポリシーをご確認ください。

コメントとは

コメント（英: comment）とは、コンピュータ言語（プログラミング言語やデータ記述言語）によって書かれたソースコードのうち、人間のために覚え書きとして挿入された注釈のことである。

コメントとは、コードに記述した注釈のことです。
例えば、次のように書きます。

// 半径 r の円の面積を求める。
int r = 2;
System.out.println(r * r * 3.14);

// から行末までがコメントとなります。
スラッシュ( / ) を２つ続けて書きます。

それでは、プログラムで実際の動きを確認してみましょう。
コードは変更せずに、そのまま「実行(Ctrl-Enter)」ボタンを押してください。

(表示がおかしいときは「コードの再読み込み」ボタンを押してみてください)

コメントの行が無視されてコードが実行されましたでしょうか？
「出力」のところに

12.56

と表示されたら成功です。

ちなみに、円の面積を求める公式は「半径 × 半径 × 円周率」ですね。

もしコメント行の // を削除したらエラーになります。
実際に、上のコードから // だけを削除して再実行してみてください。

どうでしたでしょうか？　コンパイルエラーになれば意図どおりです。

// がないと、Java のコンパイラはそれをプログラムのコードとして解釈しようとします。
しかし、Java の文法に則していないのでエラーとなったわけですね。

行末までのコメント

行末までのコメントについて、もう少し詳しくみてみましょう。
// から行末までがコメントとなるので、その手前はコメントではありません。

結果がどうなるか予想してから「実行(Ctrl-Enter)」ボタンを押してみましょう。

(表示がおかしいときは「コードの再読み込み」ボタンを押してみてください)

コメントの部分が無視されてコードが実行されましたでしょうか？
「出力」のところに

と表示されたら成功です。

コードには２か所コメントがありますが、それぞれ見てみましょう。
最初のコメントは、

x = x + 2; // テスト
           ^^^^^^^^ <-- ここがコメント

です。
// から行末までがコメントなので、

x = x + 2;

この部分は実行されます。

２か所めのコメントは、

// x = x + 3;
^^^^^^^^^^^^^ <-- ここがコメント

です。

x = x + 3;

この部分はコメントなので実行されません。

つまり、先ほどのコードは、下記のコードを実行したのと同じということですね。

int x = 10;
x = x + 2;
x = x + 4;
System.out.println(x);

指定範囲のコメント

/* と */ で囲んだ範囲もコメントにできます。
例えば、複数行をまとめてコメントするのには便利ですね。

/*
    複数行の
    コメントが
    書けます
*/

結果がどうなるか予想してから「実行(Ctrl-Enter)」ボタンを押してみましょう。

(表示がおかしいときは「コードの再読み込み」ボタンを押してみてください)

コメントの部分が無視されてコードが実行されましたでしょうか？
「出力」のところに

と表示されたら成功です。

コードには２か所コメントがありますが、それぞれ見てみましょう。
最初のコメントは、

/*
x = x + 2; 
x = x + 3;
*/

です。
コメントは /* から */ までなので、

x = x + 2; 
x = x + 3;

この部分はコメントですね。

次のコメントは

x = x /* + 5 */+ 6;
      ^^^^^^^^^ <-- ここがコメント

です。
このように、１行のなかに指定範囲のコメントを書くこともできます。

まとめると、先ほどのコードは下記のコードを実行したのと同じです。

int x = 10;
x = x + 4;
x = x + 6;
System.out.println(x);

コメントの注意点

コメントが適切に書かれていると、コードの意図を理解するのに役立ちます。
ただし、コメントの書きすぎは、かえってコードが読みにくくなることもあります。

もし興味がありましたら、下記の関連記事もご参照いただけたら幸いです。

応用問題

【問題】

int x = 1;
int y = 2;
int z = 3;

x = z + 3;
y = x - 4;
z = y * 5;

System.out.println(z);

上記コードに // または /* */ だけを書き加えます。
その結果として、「出力」が 10 になるようにしてください。

それでは、下のプログラムに // または /* */ を書き加えて「実行(Ctrl-Enter)」してみましょう。

(表示がおかしいときは「コードの再読み込み」ボタンを押してみてください)

無事に、「出力」が 10 となりましたでしょうか？
もし解けなかった場合は、下記の回答例をご参照ください。

回答例

【コード】

public class Main {
    public static void main(String[] args) {
        int x = 1;
        int y = 2;

        x = y * 3;
        y = x /*+ y*/ + 4;

        System.out.println(y);
    }
}

【出力】

まとめ

今回は、次のことを学習しました。

行末までのコメントには // を使う
指定範囲のコメントには /* */ を使う

コメントを適切に使えば、コードは読みやすくなるでしょう。
ぜひ有効に活用したいですね。

次回は「手を動かして学ぶ Java入門 (文と式の違い)」になります。