Javaの基礎【コメント】

2016年06月14日

Javaの基礎【コメント】

コメントとは、コンピュータがプログラム実行時に無視する文字列のことです。
プログラムの実行時には、無視されるため、実行時には意味を持ちません。

複数人でシステムを開発していた場合、作成したソースコードを別の人が読んだとき、
また、同じ人であっても時間をおいてから読んだりした場合には、その意図を読み取ることが困難なことがあります。
その為に、コードの意図をコメントとしてソースコードに挿入することが役立ちます。

Javaのコメントは行コメント、ブロックコメント、ドキュメントコメントの３種類があります。

行コメント

行コメントは「//」を使用します。プログラム中に「//」が現れた場合「//」から行末までをコメントとして扱います。

class Sample {
    private String shainNum = "1234";

    public static void main(String[] x_args) {
        
        //初期化処理をする
        String p_shainNm;   //社員名

        //社員の情報を取得する
        p_shainNm = getShainNm(shainNum);

        //社員の情報を表示する
        System.out.println("社員番号:" + shainNum);
        System.out.println("社員名:" + p_shainNm);
    }
    private static String getShainNm(String x_shainNum) {
        //コメントの説明なので処理は省略
        return "社員名";
    }
}

class Sample {

private String shainNum = "1234";

public static void main(String[] x_args) {

//初期化処理をする

String p_shainNm; //社員名

//社員の情報を取得する

p_shainNm = getShainNm(shainNum);

//社員の情報を表示する

System.out.println("社員番号:" + shainNum);

System.out.println("社員名:" + p_shainNm);

}

private static String getShainNm(String x_shainNum) {

//コメントの説明なので処理は省略

return "社員名";

}

行コメントは主に変数の説明、メソッド内の処理の説明で使用します。

ブロックコメント

「/* */」を使用します。プログラム中に「/*」が現れた場合、次に「*/」が現れるまでの部分を全てコメントとして扱います。

class Sample {
	private String shainNum = "1234";

	public static void main(String[] x_args) {
		
		//初期化処理をする
		String p_shainNm;	//社員名

		//社員の情報を取得する
		p_shainNm = getShainNm(shainNum);

		//社員の情報を表示する
/*
		System.out.println("社員番号:" + shainNum);
		System.out.println("社員名:" + p_shainNm);
*/
	}

	private static String getShainNm(String x_shainNum) {

		//コメントの説明なので処理は省略
		return "社員名";
	}

}

class Sample {

private String shainNum = "1234";

public static void main(String[] x_args) {

//初期化処理をする

String p_shainNm; //社員名

//社員の情報を取得する

p_shainNm = getShainNm(shainNum);

//社員の情報を表示する

System.out.println("社員番号:" + shainNum);

System.out.println("社員名:" + p_shainNm);

}

private static String getShainNm(String x_shainNum) {

//コメントの説明なので処理は省略

return "社員名";

}

ブロックコメントは処理の説明や問題のありそうな場所を一旦無効にして実行したいとき等に使用します。

ドキュメントコメント

「/** */」を使用します。プログラム中に「/**」が現れた場合、次に「*/」が現れるまでの部分を全てコメントとして扱います。

/**
 * クラスの説明
 * @author 作成者
*/
class Sample {
	/** 社員番号 */
	private String shainNum = "1234";
	/**
	 * メイン処理
	 * @param x_args 実行時のパラメータ
	 */
	public static void main(String[] x_args) {
		//初期化処理をする
		String p_shainNm;	//社員名
		//社員の情報を取得する
		p_shainNm = getShainNm(shainNum);
		//社員の情報を表示する
		System.out.println("社員番号:" + p_shainNum);
		System.out.println("社員名:" + p_shainNm);
	}
	/**
	 * 社員番号より社員名を取得する
	 * @param x_shainNum 社員番号
	 * @return 社員名
	 */
	private static String getShainNm(String x_shainNum) {
		//コメントの説明なので処理は省略
		return "社員名";
	}
}

/**

* クラスの説明

* @author 作成者

class Sample {

/** 社員番号 */

private String shainNum = "1234";

/**

* メイン処理

* @param x_args 実行時のパラメータ

public static void main(String[] x_args) {

//初期化処理をする

String p_shainNm; //社員名

//社員の情報を取得する

p_shainNm = getShainNm(shainNum);

//社員の情報を表示する

System.out.println("社員番号:" + p_shainNum);

System.out.println("社員名:" + p_shainNm);

}

/**

* 社員番号より社員名を取得する

* @param x_shainNum 社員番号

* @return 社員名

private static String getShainNm(String x_shainNum) {

//コメントの説明なので処理は省略

return "社員名";

}

ドキュメントコメントは主にクラス、フィールド、メソッドの説明に使用します。コメントの範囲はブロックコメントと同じですが、決められたルールに従って記述すればクラスのAPI（クラスの使用方法、説明が記述されたドキュメント）が自動生成することができます。

また、クラスの説明やメソッドのコメントには「@」から始まるアノテーションを使用することになりなります。どのアノテーションを使用するかは、開発のプロジェクト毎に決めていることもあり、開発前に決めていたほうが望ましいでしょう。

上記サンプルで使用しているアノテーション

@author クラスの作成者を記述する
@param メソッドの引数の説明を記述する
@return メソッドの戻り値の説明を記述する

KENスクールブログ | パソコン教室・パソコン講座なら個別指導のKENスクール

BLOGKENスクールブログ