【Java入門】コメントの種類と書き方(Javadocに関する規約も解説)

コメントを記入しておくと、後からプログラムの内容を確認したり、再利用したりする場合にわかりやすくなります。

またJavadoc用のコメントを記述しておくと、自分で作ったメソッドやクラスなどを他の人が利用しやすくなります。

そこでこの記事では、コメントについて以下の内容で解説していきます。


・コメントとは?
・1行コメントの書き方
・複数行コメントの書き方
・Javadocコメントの書き方

今回はコメントについて、わかりやすく解説していきますので、ぜひ参考にしてください!

コメントとは

コメントとは、プログラム実行時に無視される記述のことです。

ですので、プログラムの動作には何の影響もありません。

後からプログラムの内容を確認したり、再利用したりする場合にわかりやすくなるように記述します。

1行コメント

Javaではコメントを1行で書く場合と複数行で書く場合とで書き方が違います。

1行で書く場合は「//」のあとにコメントを記述します。

// 1行のコメント

複数行コメント

複数行で書く場合は「/*」と「*/」の間にコメントを記述します。

/*
複数行の
コメント
*/

Javadocコメント

JavadocとはJavaのソースコードからHTML形式のAPI仕様書を生成するソフトのことです。

Javadocのフォーマットに従って記述しておくと定義したメソッドやクラスを説明するドキュメントをJavadocで簡単に作成することができます。

Javadocコメントを書く場合は「/**」と「*/」の間にコメントを記述します。

/**
Javadocコメント
*/

1行コメントの書き方

1行コメントの書き方をサンプルコードで確認しましょう。

public class Hello {
    public static void main(String[] args) {
        // ディスプレイに表示するためのメソッド
        System.out.println("Hello Java!");
    }
}

実行結果:

Hello Java!

コメント「ディスプレイに表示するためのメソッド」はプログラムの実行には何の影響も与えていません。

複数行コメントの書き方

複数行のコメントの書き方をサンプルコードで確認しましょう。

public class Hello {
    public static void main(String[] args) {
        /*
        ディスプレイに
        表示するためのメソッド
        */
        System.out.println("Hello Java!");
    }
}

実行結果:

Hello Java!

Javadocコメントの書き方

Javadocコメントの書き方をサンプルコードで確認しましょう。

/**
 * @author Samurai Engineer
 * @version 0.0.1
 */

 /**
  * Javadoc解説用のメインクラス
  */
public class Hello {
    /**
     * mainメソッド
     * @param args 使用しない
     */
    public static void main(String[] args) {
        // ディスプレイに表示するためのメソッド
        System.out.println("Hello Java!");
    }
}

実行結果:

Hello Java!

下記のようにjavadocコマンドを使うとソースコードからドキュメントを作成することができます。

javadoc -d html Hello.java

htmlという名前のフォルダが作成され,ドキュメントがそのフォルダ内に作られます。

フォルダhtml内のindex.htmlをWebブラウザで開くとドキュメントの内容を確認できます。

規約

以下の表のように「@」(アットマーク)がついたタグが用意されています。

タグ説明
@atuthorプログラムの作成者
@version作成したプログラムのバージョン
@paramメソッドの引数の説明
@returnメソッドの戻り値の説明

まとめ

今回はコメントについて解説してきましたが、いかがでしたか?

コメントを記入しておくと、後からプログラムの内容を確認したり、再利用したりする場合にわかりやすくなります。

またJavadoc用のコメントを記述しておくと、自分で作ったメソッドやクラスなどを他の人が利用しやすくなります。

コメントを活用して楽にプログラムが利用できるように、この記事を何度も参考にして下さいね!

LINEで送る
Pocket

ITエンジニアへ転職したい方におすすめ

自分を評価してくれる企業に転職して年収を上げたい! 自分のスキルにあった独自案件を知りたい!
エンジニアは今もっとも注目されている職業の1つ。エンジニアになって年収を増やしたい方や、あなたのスキルに見合った企業へ転職したいエンジニアの方も多いですよね。

しかし、大手の転職媒体は扱う求人数が多くても、誰もが登録しているので競争率もかなり高くなっています。そのため、あなたの条件に見合った企業を見つけても転職するためには、相応の努力とスキルが必要となります。

こういった媒体では、未経験からエンジニアを目指す方やエンジニア歴2〜3年で転職を考えている方にとって、最適な転職環境とはいえません。

そこでオススメしたいのが、未経験者や若手エンジニア向けの独自案件を多く掲載している「侍ワークス」です。

侍ワークスは、独自案件を多く掲載しているだけでなく、

・応募から就業まで一貫したサポート

・就業後もアフターフォロー

といった経験の浅い方や初めてエンジニアを目指す方にも安心のフォロー体制が整っています。もちろん登録は完全無料!しかも案件を見るだけなら登録も不要です。

まずは、お気軽にどんな求人があるか見てみてください。あなたにピッタリの企業がきっと見つかりますよ! 侍ワークスの求人情報を見る

書いた人

長野 透

長野 透

熊本在住のフリープログラマ兼ライターです。C/C++/C#、Java、Python、HTML/CSS、PHPを使ってプログラミングをしています。専門は画像処理で最近は機械学習、ディープラーニングにはまっています。幅広くやってきた経験を活かしてポイントをわかりやすくお伝えしようと思います。
お問合せはこちらでも受け付けています。
[email protected]