の ジャワ コメントは、コンパイラやインタプリタによって実行されないプログラム内のステートメントです。
コード内でコメントを使用するのはなぜですか?
- コメントは、コードの詳細を追加することでプログラムを読みやすくするために使用されます。
- これにより、コードの保守が容易になり、エラーを簡単に見つけることができます。
- コメントは、に関する情報や説明を提供するために使用できます。 変数 、 方法、 クラス 、または任意のステートメント。
- 代替コードのテスト中にプログラム コードの実行を防止するためにも使用できます。
Java コメントの種類
Java には 3 種類のコメントがあります。
- 一行コメント
- 複数行のコメント
- ドキュメントのコメント
1) Java の 1 行コメント
単一行コメントは、コードの 1 行だけをコメントするために使用されます。これは、ステートメントにコメントを付ける最も簡単な方法で広く使用されています。
単一行のコメントは 2 つのスラッシュで始まります (//) 。 // の前にあるテキストは Java によって実行されません。
構文:
//This is single line comment
Javaプログラムで一行コメントを使ってみましょう。
コメント例1.java
public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } }
出力:
10
2) Java の複数行コメント
複数行コメントは、複数行のコードにコメントを付けるために使用されます。これは、複雑なコード スニペットを説明したり、一度に複数行のコードにコメントするために使用できます (単一行のコメントを使用するのは難しいため)。
複数行のコメントは /* と */ の間に配置されます。 /* と */ の間のテキストは Java によって実行されません。
構文:
スパークチュートリアル
/* This is multi line comment */
Javaプログラムで複数行コメントを使ってみましょう。
コメント例2.java
public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } }
出力:
10
注: 通常、// は短いコメントに使用され、/* */ は長いコメントに使用されます。
3) Java ドキュメントのコメント
ドキュメント コメントは、ドキュメント API の作成に役立つため、通常、プロジェクトまたはソフトウェア アプリケーション用の大規模なプログラムを作成するために使用されます。これらの API は、コード内でどのクラス、メソッド、引数などが使用されているかを参照するために必要です。
ドキュメント API を作成するには、 Javadocツール 。ドキュメントのコメントは /** と */ の間に配置されます。
構文:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
Javadocタグ
ドキュメントのコメントでよく使用されるタグのいくつかは次のとおりです。
鬼ごっこ | 構文 | 説明 |
---|---|---|
{@docRoot} | {@docRoot} | 任意のページから生成されたドキュメントのルート ディレクトリへの相対パスを示します。 |
@著者 | @著者名 - テキスト | クラスの作成者を追加します。 |
@コード | {@コードテキスト} | HTML マークアップまたはネストされた Javadoc タグとして解釈せずに、コード フォントでテキストを表示します。 |
@バージョン | @version バージョンテキスト | -version オプションを使用する場合に、「バージョン」小見出しとバージョン テキストを指定します。 |
@以来 | @リリース以来 | 生成されたドキュメントに「since」見出しと、since テキストを追加します。 |
@param | @param パラメータ名 説明 | 指定された名前と説明を持つパラメータを「パラメータ」セクションに追加します。 |
@戻る | @return 説明 | 何かを返すすべてのメソッドに必要です (void を除く) |
Java プログラムで Javadoc タグを使用してみましょう。
計算.java
import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println('Addition of numbers: ' + result); } } </p>
javac ツールでコンパイルします。
ドキュメントの作成
ドキュメント API を作成する Javadoc 道具:
これで、HTML ファイルが作成されました。 計算する 現在のディレクトリ内のクラス、つまり、 abcデモ 。 HTML ファイルを開くと、ドキュメントのコメントを通じて Calculate クラスの説明が表示されます。
Javaのコメントは実行可能ですか?
年: ご存知のとおり、Java コメントはコンパイラやインタプリタによって実行されませんが、処理を容易にするために、コンパイラでのコードの字句変換の前に、コードの内容が ASCII にエンコードされます。
テスト.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } }
出力:
コンパイラが Unicode 文字 を解析するため、上記のコードは出力を生成します。 う000d として 改行 字句変換の前に、コードは次のように変換されます。
テスト.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } }
したがって、Unicode 文字は print ステートメントを次の行に移動し、通常の Java コードとして実行されます。