JAVAのコメントの種類と書き方・気をつけること

パソコンとスマホを使う人

JAVAにコメントを書く方法は3種類!「//」「/* */」「/** */」です。

コメントが記述されているときは、コンパイル・実行時にムシされます。

なので実行結果に影響を与えません。

JAVAでコメントを書く方法は3種類

JAVAでコメントする記述は3種類あります。

「//」でコメント(とてもよく使う)

1行だけコメントを書くときに使います。

「//コメント」でコメントする記述
//コメント

「//」のうしろがすべてコメント。

eclipseを使っている方は「ctrl + /」でも「//」を入力できます。

「/* */」でコメント(とてもよく使う)

複数行にわたりコメントを書くことができます。

「/* コメント */」でコメントする記述
/* コメント
コメント
コメント
コメント*/

「/* */」ではさまれた内容がすべてコメント。

各行に「//」しなくていいので便利です。

「/** */」でコメント(あまり使わない)

「/** コメント */」でコメントする記述
/** コメント
コメント
コメント
コメント*/

JavaDocといわれるものです。

JavaのソースコードからHTML形式のAPI仕様書を生成します。

※ここまで読んで、よく分からない方はスルーしてください。

「//」でコメントする記述の使い方

Hello World
こんにちは 世界

と出力する記述があります。

JAVAのプログラム
public class Sample {
  public static void main (String[] args) {
    System.out.println("Hello World");
    System.out.println("こんにちは 世界");
  }
}

System.out.println(“Hello World”);を「//」でコメントをして、コンパイルと実行します。

JAVAで「こんにちは 世界」を出力するプログラム
public class Sample {
  public static void main (String[] args) {
    //System.out.println("Hello World"); //2018-07-15 Taro.Tanaka
    System.out.println("こんにちは 世界");
  }
}

すると、

こんにちは 世界

と出力され、Hello World はコメントになり出力されません。

「/* */」でコメントする記述の使い方

「/* */」は1番最初に書くことが多いです。

そして5W1Hでプログラムの概要を書きます。

他には、不要なプログラムを動作させないために使うことがあります。

以下のプログラムは、「こんにちは World」を出力させるコートをまるまるコメントにしています。

JAVAで「Hello World」を出力するプログラム
/*
  作成日:2018-07-15
  作成者:Taro.Tanaka
  最新ver:2.2.3
  内容:コメントの種類と書き方
*/
public class Sample {
  public static void main (String[] args) {
    System.out.println("Hello World");
  }
}

/* 2018-07-15 Taro.Tanaka
public class Sample {
  public static void main (String[] args) {
     System.out.println("こんにちは World");
  }
}
*/

コンパイルと実行すると、

Hello World

だけが出力されます。

「/** */」でコメントする記述の使い方

あまり見る機会がない「/** */」の例をWikipediaに載っていたので紹介します。

JAVAで「/** */」を使った例
/**
  * クラスの説明.
  *
  * ピリオド(.)または句点(。)で終わるところまでが、
  * クラス一覧の概要に説明されるところであり、
  * ピリオド以降は説明の概要には含まれず、クラスの説明に含まれる。
  * このように、JavadocにはHTMLタグを使用することができる。
  *
* @param 総称型パラメータの説明
* @param 総称型パラメータの説明
* @author Wikipedian
* @author Second author
* @version 1.6
* @since 1.0
*/
public class JavadocSample<T1, T2 extends List> {
/**
* @serial 直列化可能データの説明
*/
private int x;
/**
* Validates a chess move.
* @author John Doe
* @param theFromFile File of piece being moved
* @param theFromRank Rank of piece being moved
* @param theToFile File of destination square
* @param theToRank Rank of destination square
* @return true if a valid chess move or false if invalid
*/
boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank)
{
//...
}
/**
* 非推奨メソッド。
* @deprecated このメソッドは非推奨です。
* @param t 説明
* @throws SomeException 例外の説明
*/
String deprecatedMethod() {
//...
}
/**
* メソッドの説明。
* @param t 説明
* @throws SomeException 例外の説明
* @throws Exception 例外の説明
* @return String型の値
* @since 1.5
* @see "関連"
* @see Example
* @see String#equals(Object) equals
*/
String add(T1 t) throws SomeException, Exception {
}
}

Wikipediaより引用(一部編集)

JavadocについてWikipediaにがっつり載ってるので、気になる方は参考にしてください。

参考 JavadocWikipedia

コメントを書くときに気をつけること

パソコンとスマホを使う人

自分にしか見せない記述であれば何を書いてもいいですが、誰かに見せるなら

・なるべくシンプルなコメントにする
・いつ誰が書いたか分かるようにする

の2点を気をつけるようにしています。

たとえば、数年前に書いた記述を再利用する機会があるときに

おいもさん

間違った記述か、あえて普段と違う記述にしたか分からない…

といった場面に遭遇することがあります。

だから記述を修正していいか分からなくて、作業が止まってしまう…

せめて、いつ・誰が書いたか分かれば質問や推測できます。

なので今回は「//2018-07-15 Taro.Tanaka」のように記述しました。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です