コメントの記述

ソースコードを書く上で、コメントは非常に重要です。自分が記述したソースコードを他の人が見た時に分かりやすく、かつ間違いが起きにくくなる為に、コメントの記述は必須とも言えるでしょう。

コメントの記述 目次

1. コメントの記述
2. 単一行コメントの書き方
3. 複数行コメントの書き方

１．コメントの記述

コメントとは、プログラムの命令文やクラス宣言などではなく、プログラムを実行する上では何の意味もない文章のことです。では、何に使用するのかと言うと、それはプログラマ（プログラムを作る人）が、ソースコードの説明文や注意点などをメモとして記録するためです・

コメントを記述することは、個人が趣味でプログラムを作る場合は無くても構わない（自分しか見ないから）のですが、仕事でシステム開発を行う際は必須です。仕事でシステム開発を行う際は、まず間違いなく自分が書いたソースコードを他人が修正することになります。裏を返せば、他人が書いたソースコードを自分が修正することになります。

ソースコードの書き方は意外に自由で、同じ処理結果を得る為に何通りもの書き方が存在します。ですので、一見して何を行っている処理なのかが分からないことが良くあります。そういう場合に、コメントで説明を書き加えることで、他の人が見た際に分かりやすくなります。

２．単一行コメントの書き方

コメントの書き方にはルールが存在します。単一行だけのコメントを表す場合と、複数行のコメントを表す場合の2通りです。

単一行コメントを書くには、「//」スラッシュを2つ入力します。「//」が出現した箇所から行末までがコメントになりますので、通常は先頭に「//」を書きます。

//　この行はコメントになります

文の途中に単一行コメントを書くこともできます。

ここまではソースコードとして認識される。//ここからコメントになります

日本語で説明を書いているとおり、「//」の左（。）まではJavaのソースコードとして認識されますが、「//」以降文末まではコメントとして解釈されます。

実際のプログラムで試してみるとこのようになります。

6行目と8行目は、行全体がコメントになっています。9行目は、HelloWorldの出力まではソースコードとして解釈されており、「//」以降の部分がコメントになっています。そして、10行目は、printlnのソースコードの途中で「//」が入力されています。

こうなった場合、「System.」までがプログラムのソースコードとして解釈されることになります。もちろんこれではソースコードの記述ミス（「コンパイルエラー」と言います）となり実行できません。これは、次のように書いたのと同じ意味になります。

３．複数行コメントの書き方

複数行コメントとは、クラス宣言などのように、コメントの開始と終了を表す記号で挟まれた部分がコメントになる書き方です。複数行を纏めて囲むこともできます。

開始を表す記号は「/*」で、終了を表す記号は「*/」となります。

/*　複数行コメント　*/

実際のプログラムで試してみましょう。

「/*」と「*/」で囲んだ部分は、複数行にわたってコメントになっています。この画像ではオレンジの枠で囲んでいますが、実際には「/*」が出現した箇所から、「*/」が出現するまでの間全てをコメントにする、という意味ですので注意が必要です。

「/*」と「*/」で囲まれた中に存在する文字はコメントになりますが、例外もあります。「*」だけなら大丈夫（コメントになる）のですが、「/*」と「*/」を入れ子にするのはNGです。

なお、単一行コメントは複数行に跨がって適用はされませんが、複数行コメントは単一行のみに記述することが可能です。

このソースコードが一体何の処理を行っているのか、何のためにこれを記述しているのか、その他注意点や修正する時はこうして下さいというようなお願いなど、ソースコードにコメントは充実させましょう。それがプログラムの品質向上に確実に繋がります。