Javaでコメントを書く方法｜1行・複数行・JavaDocを解説

こんにちは、Mochiです。

🤔 Javaでコメントってどうやって書くんだっけ？
🤔 Javaの複数行コメントってどんな感じだ？

そんな方に向けて、この記事ではJavaでのコメントの書き方をわかりやすく解説します！

この記事を読むことで、1行や複数行のコメントを押さえることができます。

1行のコメント//

コメントを書くことで、プログラムとしては実行せずにソースコードの中に文章を残すことができます。

Javaで1行分のコメントを書く際には、//を使います。

書き方

1行のコメントの書き方は次の通りです。

// コメント内容

例

例えば、コメントでコードの解説を書けます。

// 変数に代入
String title = "Mochi Blog";
    
System.out.println(title); // Mochi Blogと表示する

実行結果ではコメントは表示されません。

Mochi Blog

また、コードを実行させない状態にするコメントアウトができます。

// System.out.println("Mochi Blog");

実行結果ではコードが実行されないため、何も表示されません。

一時的にコードを実行させたくない場合に便利です。

複数行のコメント/ /

1行だけでなく、複数行をまとめてコメントにしたい場合は/* */を使います。

書き方

複数行のコメントの書き方は次の通りです。

/* 
コメント内容
コメント内容
*/

例

例えば、次のように複数行の内容をコメントにできます。

/* 
コメントアウト
String title = "Mochi Blog";
        
System.out.println(title);
*/

JavaDocコメント /* /

JavaDocというツールを使って、コメントからドキュメント（マニュアル）を作成するには/* / を使います。

書き方

JavaDocコメントの書き方は次の通りです。

/**
* ドキュメント内容
* ドキュメント内容
*/

例

例えば、次のようにドキュメントとして書いておきたい内容を書きます。

/**
* printerメソッド
* @param 引数なし
* @return 戻り値なし
*/
public static void printer(){
    System.err.println("Mochi Blog");
}

タグ

JavaDocコメントでは次のタグを使うことができます。

• @author: プログラムの作成者
• @version: 作成プログラムのバージョン
• @param: 引数
• @return: 戻り値

まとめ

この記事ではJavaでのコメントの書き方を解説しました。

プログラミングを学んで稼げるようになるためには、どんな内容をどんな順番で学んでいくかが重要です。気になる方は次の記事を参考にしてみてください。
🫱 ゼロからプログラミングで稼げるようになるまでのロードマップ

また、プログラミングについて学べる書籍はたくさんあります。読んでみたい方は、次の記事をご覧ください。
🫱 初心者におすすめのプログラミング勉強本10選｜最適本が見つかる！