【Java超入門】もっと分かりやすいプログラムに!コメントで「おしゃべり」させよう

docs

こんにちは!Javaプログラミングの森を冒険中の皆さん、いかがお過ごしですか?前回は変数について学んで、プログラムにデータを「名前」で覚えさせる方法を知りましたね。(前回の記事はこちらからどうぞ!→ データ型を使いこなそう (整数、小数、真偽値など) | ToolDocs

さて、変数を使いこなせるようになって、ちょっとずつプログラムが書けるようになってきたかな?でもね、プログラムって、書いているときは「よし、これでバッチリ!」って思っても、後から見返すと「あれ?これ何のために書いたんだっけ…?」ってなっちゃうこと、結構あるあるなんです。

まるで、大事なメモを取ったはずなのに、後で見たら暗号みたいで意味不明…みたいな感じ(笑)。

そんな「後から見たら意味不明」を防ぐための、めちゃくちゃ便利な機能が今回ご紹介する「コメント」なんです!

コメントって何?プログラムの中の「おしゃべり」タイム!

コメントとは、プログラムの中に書く「人間のためのメモ」のこと。プログラムを実行するときには、コンピューターはコメントを無視して、プログラムの処理だけを実行します。だから、どれだけたくさんコメントを書いても、プログラムの動きには一切影響しないんです。

例えるなら、料理のレシピに「この調味料は隠し味だよ!」とか「焦げ付かないように注意!」って書き添えるようなもの。料理自体には影響ないけど、作る人にとってはすごく助かりますよね?それと同じです!

コメントの書き方、2種類マスターしよう!

Javaでコメントを書く方法は、主に2種類あります。

1. 1行コメント(//

これは、//(スラッシュ2つ)を書いた行の、//より右側が全てコメントになる書き方です。ちょっとした説明を加えたいときに便利です。

Java

public class MyProgram {
    public static void main(String[] args) {
        int age = 30; // ここに年齢を代入しています
        System.out.println("私の年齢は" + age + "歳です。"); // 画面に年齢を表示
    }
}

この例だと、「// ここに年齢を代入しています」と「// 画面に年齢を表示」がコメントになります。

2. 複数行コメント(/* */

こちらは、/*から*/で囲まれた範囲が全てコメントになる書き方です。プログラムの大きな塊の説明や、一時的にコードを動かしたくないとき(「コメントアウト」と呼びます)なんかに使います。

Java

public class MyProgram {
    public static void main(String[] args) {
        /*
         * この部分は、ユーザーからの入力を受け取る処理です。
         * 後で機能を追加する予定です。
         */
        // String name = "田中"; // 現時点では使わないのでコメントアウト
        // System.out.println("あなたの名前は" + name + "です。");

        int height = 170;
        System.out.println("私の身長は" + height + "cmです。");
    }
}

この例では、ユーザー入力に関する説明と、一時的に動かしたくないString name = "田中";の行を複数行コメントで囲んでいます。

paizaで実行した結果

なぜコメントが大事なの?未来の自分と仲間を助けるヒーローになろう!

「別にコメントなんて書かなくても動くじゃん!」って思うかもしれません。でも、コメントを書くことには、とーっても大きなメリットがあるんです。

  • 未来の自分を助ける!: 数日後、数週間後に自分の書いたプログラムを見返したとき、「これ、何のために書いたんだっけ…?」ってなることを防げます。未来の自分が「コメント書いててくれてありがとう!」って感謝すること間違いなし!
  • 他の人が読んでも分かりやすい!: プログラミングは、一人でやることもあれば、チームで協力してやることもあります。あなたが書いたプログラムを他の人が読むとき、コメントがあれば、そのプログラムが何をしているのか、なぜそのように書かれているのかがすぐに理解できます。あなたは「プログラムを分かりやすく書ける人」として一目置かれるでしょう!
  • 間違い探しがラクになる!: もしプログラムがうまく動かないときに、コメントがあれば、どこで何をしているのかが分かりやすくなり、原因を見つけやすくなります。

コメントを上手に使うコツ

  • 「なぜそう書いたのか」を説明する: 「何をしているか」だけでなく、「なぜそうするのか」を説明すると、さらに分かりやすくなります。
  • 複雑な処理に説明を加える: ちょっとややこしい計算や処理の前に、簡単な説明を入れてあげると親切です。
  • 適度な量を心がける: コメントだらけだと、かえって読みにくくなることもあります。必要な場所に、必要なだけ書くのがポイントです。
  • 更新する: プログラムを修正したら、コメントも忘れずに修正しましょう。古いコメントは混乱の元になります。

まとめ:コメントはプログラミングの「思いやり」!

コメントは、プログラムをより分かりやすく、そしてメンテナンスしやすくするための強力なツールです。まるで、プログラムがあなたや他の人に「ねぇねぇ、ここね、こういうことしてるんだよ!」っておしゃべりしてくれるみたいですよね。

Javaを始めたばかりの皆さん、ぜひ今日から「コメントを書く習慣」をつけてみてください。きっと、未来のあなたや、もし一緒にプログラミングする仲間ができたら、彼らがあなたに感謝するはずです!

コメント

タイトルとURLをコピーしました