ホーム プログラミング言語 java Java プログラミングの基礎 Java コメント: 単一行、複数行、およびドキュメントのコメント

Java コメント: 単一行、複数行、およびドキュメントのコメント


 
 
アノテーションはプログラム言語の説明であり、開発者とユーザー間のコミュニケーションに役立ち、プログラムの理解を容易にします。コメントはプログラミング ステートメントではないため、コンパイラによって無視されます。

 

Java は、次の 3 つのアノテーション メソッドをサポートしています。

1) 一行コメント

ダブルスラッシュ「//」で識別され、1行のみコメント可能で、コメント情報の内容が少ない箇所で使用されます。図 1 に示すように、Eclipse を開き、Java コードで単一行のコメントを使用します。

図 1 単一行コメント (google imageより)
図 1 単一行コメント (google imageより)

2) 複数行のコメント

「/*」と「*/」の間に入れると、複数行の内容をコメント化できます。読みやすさを高めるため、図 2 に示すように、通常、最初の行と最後の行にはコメント情報を記述しません (これもより美しくなります)。

注: 複数行のコメントは単一行のコメントをネストできますが、複数行のコメントとドキュメントのコメントはネストできません。

図 2 複数行のコメント
図 2 複数行のコメント

3) ドキュメントのコメント

「/**」と「*/」の間に含まれ、複数行にコメントすることもでき、通常、クラス、メソッド、変数の機能を説明するために使用されます。コメントを付けた後、クラスと変数の上にマウスを置くと、図 3 に示すように、コメントの内容が自動的に表示されます。

注: ドキュメント コメントは単一行コメントをネストできますが、複数行コメントとドキュメント コメントをネストすることはできません。通常、最初と最後の行にはコメント情報は記述されません。

ドキュメント コメントでは、Javadoc コマンドを使用してドキュメント コメントの内容からドキュメントを生成し、それを HTML ファイルに出力できます。これは、プログラム情報を記録するのに便利です。 1 つ以上の @ タグを含めることもでき、各 @ タグは新しい行で始まります。 Javadoc の特定のタグと使用法については、「 Javadoc 入門チュートリアル」セクションを参照してください。

Java では、コメント行は二重スラッシュ「//」で識別され、複数行のコメントは「/*」と「*/」で囲まれ、ドキュメント コメントは「/**」と「*/」で囲まれます。コンパイラは、「//」まで実行すると、「//」行以降のテキストをすべて無視します。「/*」まで実行すると、次の「*/」をスキャンし、「/*」と「の間のテキスト」を無視します。 */”; “/**” が実行されると、次の “*/” もスキャンされ、”/**” と “*/” の間のテキスト コンテンツは無視されます。

 

「 Java コメント: 単一行、複数行、およびドキュメントのコメント」についてわかりやすく解説!絶対に観るべきベスト2動画

ドキュメント③「Googleドキュメントにコメントをつける」
いまさら聞けない!?Googleドキュメントのコメントを抽出してmiroに付箋で貼り付け