【Java】コメントの種類をやさしく解説|使い分けと注意点を実務目線で整理

Java入門・実践
スポンサーリンク
スポンサーリンク

はじめに

Java のコードを書くときに欠かせないのが
コメント(注釈)

  • // は一行コメント
  • /* */ は複数行コメント

という知識は知っていても、
「どう使い分けるの?」
「実務ではどんな書き方が良いの?」
と迷うこともあります。

この記事では、やさしく・実務寄りに
Java のコメントの種類と使い方を整理していきます。


まずはコードを確認

Java
// これは一行コメントです

/*
  これは複数行コメントです
  何行でも書けます
*/

/**
 * これはドキュメンテーションコメントです
 * JavaDoc 生成に使われます
 */
public class Sample { }

コードのしくみを解説

一行コメント(//)

Java
// ここにコメントを書く
  • 行の途中から書ける
  • その行の終わりまでがコメント
  • ちょっとした説明に最適

イメージ:

  • 「メモ書き」
  • 「補足」
  • 「意図の説明」

複数行コメント(/* */)

Java
/*
  ここに複数行のコメントを書く
  長めの説明に使える
*/
  • 複数行にまたがるコメント
  • ブロック全体を説明したいときに便利
  • 一時的にコードをコメントアウトするときにも使われる

ドキュメンテーションコメント(/** */)

Java
/**
 * メソッドの説明
 * @param name 名前
 * @return あいさつ文
 */
public String hello(String name) { ... }
  • JavaDoc を生成するための特別なコメント
  • クラス・メソッド・フィールドの説明を書く
  • 実務では API の説明に必須

あわせて知っておきたいポイント

コメントアウトの入れ子はできない

Java
/* 
  /* これは NG */
*/

複数行コメントは入れ子にできません。
実務でよくあるミスなので注意。

コメントは「なぜ」を書くと価値が高い

悪い例:

Java
i++; // i を増やす

見ればわかることを書く必要はありません。

良い例:

Java
i++; // 次のループで index を1つ進めるため

「なぜそうするのか」を書くと、
未来の自分や他の開発者が助かります。

TODO コメントもよく使われる

Java
// TODO: バリデーションを追加する

IDE が一覧化してくれるため、
作業漏れ防止に役立ちます。

実務では「コメントを書きすぎない」ことも大事

  • コードが読みやすければコメントは少なくて良い
  • コメントが古くなると逆に混乱を招く
  • 「必要なところだけ」に絞るのがポイント

使うときに気をつけたいこと

  • // は一行、/ / は複数行
  • /** */ は JavaDoc 用(特別扱い)
  • 複数行コメントは入れ子にできない
  • 「なぜ」を書くと価値が高い
  • コメントの書きすぎは逆効果

実務では「読みやすいコード」と「必要なコメント」のバランスが大切です。


まとめ

コメントの種類

  • //:一行コメント
  • /* */:複数行コメント
  • /** */:JavaDoc コメント

実務でのポイント

  • 必要なところだけコメントを書く
  • 「なぜそうするのか」を書く
  • TODO コメントも活用する

decopon
decopon

コメントは、 「未来の自分や他の開発者への手紙」です。コードだけでは伝わらない“意図”を補うことで、 読みやすく、安心して変更できるコードになります。あなたの学びが、次のステップにつながりますように。

moco
moco

// はメモ、/* */ は長文、/** */ は説明書。 そんなイメージで使い分けると、すごくわかりやすいよ。

コメント

タイトルとURLをコピーしました