Java コメント
1. Javaのコメントとは
コメントは、Javaのコードを説明し、可読性を高めるために使用されます。また、代替コードをテストする際に、特定の行の実行を一時的に防ぐ(コメントアウトする)目的でも利用されます。
2. 1行コメント (Single-line Comments)
1行コメントは、2本のスラッシュ(//)で始まります。
// からその行の末尾までのテキストは、Javaコンパイラによって無視され、実行されることはありません。
以下の例では、コード行の前に1行コメントを使用しています。
2.1 コード例:行の前に記述
// これはコメントです
System.out.println("ハロー・ワールド");以下の例では、コード行の末尾に1行コメントを使用しています。
2.2 コード例:行の末尾に記述
System.out.println("ハロー・ワールド"); // これはコメントです3. 複数行コメント (Multi-line Comments)
複数行コメント(ブロックコメント)は /* で始まり、*/ で終わります。
/* と */ の間にあるテキストは、すべてJavaによって無視されます。
以下の例では、コードの説明として複数行コメントを使用しています。
3.1 コード例
/* 以下のコードは画面に
ハロー・ワールドという言葉を表示するもので、
非常に素晴らしいプログラムです */
System.out.println("ハロー・ワールド");4. 1行コメントと複数行コメントの使い分け
どちらを使用するかは、開発者やプロジェクトのスタイルに委ねられます。
一般的には、短い説明には // を使い、2行以上の長い説明やドキュメント作成には /* */ を使用するのが標準的です。