【Javaの基礎】コメントの書き方

 

こんにちは、現役SEの「とも」です。

今さらですが、今回はコメントについてです。

コメントというのは、ソースの中に書いてはいますが、コンパイルの際にJavaが無視するように判断させる書き方です。

 

人が見て

  • 「このプログラムはどんな処理をしているのか」

が分かるようにするというのが、主な用途ですね。

 

コメントの無いプログラムは、シンプルであれば良いですが複雑なものだと「何をしているのか分からない」ということが良くあります。

 

  • コメントを付けることで、作成時のプログラムの意図が分かりやすくなります。

ただ、プログラムの意図が伝わるコメントを付けるのは案外難しいです。

 

一旦今回は、機能としてのコメントについて書きたいと思います。

まずは、コメントの表記を見ていきましょう

 

コメントの表記

 
// １行のコメントです
/* 複数行
   にまたがるコメント
   です。*/

 

コメントの記載方法には以下の２つあります。

  • コメントを１行だけ書きたい場合、「//」を付けてから書きます。
  • 複数行にまたがるコメントを書きたい場合は、「/*」～「*/」の間がコメントになります。

 

最近は、eclipseなどの統合開発ツールを利用することで、範囲を指定してコメント化したりコメント解除したりできるので、「/*」～「*/」の表記はあまり見かけなくなりました。

 

「/*」～「*/」の書き方の場合、あまり使い勝手が良くないところがあります。

我々のようなプログラマーは、調査の際にsakuraエディタのgrep機能を良く使います。

その時、

  • ソースをgrepした場合に最初と最後の行はコメントであることが分かりますが、中間の行はコメントかそうでないかが分からないのです。

そのため、後々を考えると「//」の1行コメントを使用した方が良いと思います。

 

ちなみに、コメントは以下のようにプログラムを記載した後に書くことも可能です。

「//」の記載は、「//」以降がコメントになります。

「/*」～「*/」の記載は、「/*」～「*/」の範囲がコメントになります。

 
final String type = "りんご";     // 定数：りんご
final String type = "みかん";     /* 定数：みかん */

 

javadocとしてのコメント

javaにはjavadocと言って、統合開発ツールを使う場合にメソッドを選択した時、コメントを表示してくれる機能があります。

 

きちんとjavadocを書いておくことで、メソッドの機能や引数、戻り値がソースを見なくても分かります。

javadocを書く習慣を身につけておくことで、長い目で見ると効率が格段に上がると思いますので習慣化すると良いと思います。

 

javadocのコメントは以下のように記載します。

 
/**
* ログを出力する共通処理
* @param name 名称
* @return 処理結果
*/
private static boolean comFunc( String name) {
  // 共通処理
}

 

「/**」～「*/」がjavadocの範囲ですね。

「@」から始まるものをjavadocタグと言います。

いくつかの種類がありますが、とりあえずは以下のみ覚えておけばよいでしょう。

javadocタグ 説明
@param パラメータについての説明を書きます
@return 戻り値についての説明を書きます

 

メソッド以外にもjavadocを記載することはできますが、一旦メソッドだけでも記載しておけば開発時に便利です。

 

上記のjavadocを記載した場合、eclipseでメソッドを選択した際、以下のような表示になります。

javadoc表示

 

なかなか便利な機能なので、利用してみてください。