ホーム » 学習 » Java入門:コメント

Java入門:コメント


コメントはコンピュータ言語の重要な部分であり、ソース コード内のコードの機能を説明するために使用され、プログラムの可読性と保守性を向上させることができます。

Java コメントは、コードがどのように機能するかを説明するために Java プログラムで使用されるテキストです。

コメントはコンパイラーによって最終的な実行可能プログラムに組み込まれないため、プログラムの実行には影響しません。

コメントはプログラミングの優れた実践方法であり、プログラマがコードの目的と機能をより簡単に理解するのに役立ち、チームの共同作業に非常に役立ちます。

Java アノテーションには主に 3 つのタイプがあります。

  • 一行コメント
  • 複数行のコメント
  • ドキュメントのコメント

単一行コメント

単一行のコメントは二重スラッシュ // で始まります :

// これは単一行コメント
int x = 10; // 変数xを初期化する

複数行のコメント

複数行のコメントは /* で始まり */ で終わります。

/*
これは複数行コメント
コメント文
*/
int y = 20; // 変数yを初期化する

ドキュメントコメント

基本的な書式は複数行コメントと同じですが、ドキュメント コメントは /** で始まり */ で終わります。通常、これらはクラス、メソッド、フィールドなどの宣言の前に表示され、コード ドキュメントの生成に使用されます。この種のコメントはツールで抽出して API ドキュメントを生成できます。 JavaDocなど。

/**
 * これはドキュメントコメントのサンプルコード
 * 通常、クラス、メソッド、またはフィールドに関する詳細が含まれます
 */
public class MyClass {
    // コメント
}

ドキュメント コメントの形式には、通常、メソッド パラメータを記述する @param、戻り値を記述する @return、スローされる可能性のある例外を記述する @throws など、いくつかの特定のタグが含まれています。これらのタグは、明確な API ドキュメントを生成するのに役立ちます。開発者はコードをよりよく理解し、使用できるようになります。


コメントを残す

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