トップ 言語 Java 基本知識 Javaプログラムのコメント

Javaプログラムのコメント―書き方や注意点など

Javaプログラムの書き方や注意点など。Javaプログラムのコメントについてまとめています。

Javaプログラムのコメント

Javaのプログラムには次のようなコメントがあります。

以下ではこれらのJavaのプログラムコメントの書き方、注意点をまとめています。

Javaのプログラムコメントの書き方

サンプルコードを示しながらJavaのプログラムコメントの書き方を説明していきます。

「//」から行の終わりまではコメント

プログラム中に「//」とダブルスラッシュを書いた場合、「//」から行の終わりまでがコメントになります。

Javaのコンパイラは、「//」という記号からあとの文字を無視します。 「//」記号の後ろには、プログラムの実行とは直接関係ないメモなどを書き残すことができます。

以下のサンプルコードはこのプログラムコメントの書き方の例です。

class Sample {
 	public static void main(String args[]) {
 		System.out.println("Hello World!"); //最初のプログラムは伝統的にHello World!!を出力します。
 	}
}

「//最初のプログラムは伝統的にHello World!!を出力します。」の部分がコメントになります。

「/*」と「*/」で囲んだ範囲はコメント

プログラム中に「/*」と「*/」で囲んだ範囲はコメントになります。

「//」以外に「/* ~ */」という記号を使用することもできます。 このコメントの場合は、「/*」「*/」で囲まれた部分が、すべてコメントになります。

以下のサンプルコードはこのプログラムコメントの書き方の例です。

class Sample {
 	public static void main(String args[]) {
 		/*
 		最初のプログラムは伝統的にHello World!!を出力します。
 		*/
 		System.out.println("Hello World!");
 	}
}

「/* 最初のプログラムは伝統的にHello World!!を出力します。*/」の部分がコメントになります。

「/**」と「*/」で囲んだものはJavadocコメント

クラスやメソッド、メソッドの外の変数の上部に「/**」と「*/」で囲んだコメントはJavadocコメントといいます。 コメントがJavadocという仕様書を生成する際に使われる記述となります。javadocコマンドで生成します。

以下のサンプルコードはこのプログラムコメントの書き方の例です。

/**
 * サンプルクラス
 * サンプルとして伝統的なHello World!!の文を扱うクラスです。
 * @author zealseeds
 */
class Sample {
 	public static void main(String args[]) {
 		System.out.println("Hello World!");
 	}
}

「/**」と「*/」で囲んだ部分がJavadocコメントになります。 「@」で始まる「@author <著者>」のようなJavadoc用の機能がコメントの中に書くこともできます。

「//TODO」から行の終わりまではTODOコメント

「//TODO」から行の終わりまではTODOコメントといいます。 未実装や作りかけなどの覚書に使うコメントです。 Eclipseなどの開発ツールでこのTODOコメントを抽出する機能があり、効率よく作業するためにあります。

以下のサンプルコードはこのプログラムコメントの書き方の例です。

class Sample {
 	public static void main(String args[]) {
 		//TODO 今度もっと別の表示に変更する。
 		System.out.println("Hello World!");
 	}
}

「//TODO 今度もっと別の表示に変更する。」の部分がTODOコメントになります。

プログラムコメントの注意点

プログラムコメントの注意をまとめます。

必要なコメントは適切なところに残すよう努力する

コードを書いているときは、覚えていても直ぐに忘れます。 未完成部分など将来の自分や共同開発者のために補足説明を残しておくべきです。

注意点としては、コメントがあればあるほど記述量が多くなり、読まなくてはならない量が増えます。 つまり、可読性がわるくなり、後で読みなおすときに時間がかかります。 コメントが無くても分かるようになってる方がうれしいです。

後で詳細は触れますが、必ずしもコメントをプログラムに書かなくてもいいかもです。

コメントは極力書かないように努力する

上述の通り、コメントは可読性を下げる要因にもなります。 以下のような考え方もあると思いますので参考にしてもらえればと思います。

プログラム自体の書き方

プログラム自体の書き方を工夫すれば、コメントが不要になるかもです。

仕様の残し方

仕様の残し方を工夫すれば、コメントが不要になるかもです。

まだまだ沢山あったり、ずれたことを書いているかもしれませんが、何が言いたいかというと、「コメントの少ないプログラムが実現できる=高度なテクニックがある」といいたいわけです。 はじめはコメントがたくさん必要ですが、レベルアップして、高度化して、コメントゼロのプログラムを目指したいです。

もっと知識を広げるための参考

戻る

スポンサーリンク

サイト内のページ

言語
C・C++ /HTML /Java /JavaScript /PHP /シェルスクリプト

開発環境
Ant /Bcc /Eclipse /gcc /gdb /g++ /JDK /JUnit /ZAP

技術・仕様
Ajax /CORBA /Java EE(旧称J2EE) /JNI

ライブラリ/Framework/CMS
jQuery /Lucene /MyBatis /RESTEasy /Spring /Struts /Seasar2 /WordPress

ITインフラ OSとミドルウェア
Linux /Windows /シェル
Apache/Tomcat /MySQL /Redis /Solr /vsftpd

ITインフラ PC 製品
ZOTAC

ITインフラ サーバー
Web公開サーバー構築

ITインフラ ネットワーク
プログラミング /機器 /構築

ITインフラ セキュリティ
公開サーバーのセキュリティ

SI
ホームページの作り方 /小さな会社のISMS

その他
IT用語 /ITスキル体系 /トレンド履歴

スポンサーリンク