Javaドキュメントのコメント

Javaはいくつかの方法だけで3種類の注釈します。 最初の二つは、//と/ * * /であり、そして第三は、* /と/ **、終わりで始まり伝説のコメントと呼ばれています。

説明コメントは、プログラム内のプログラムについての情報を埋め込むことができます。 あなたは、HTMLファイルに情報を出力を生成するために、javadocツールを使用することができます。

説明コメントは、あなたがあなたのプログラムに関するより多くの情報を記録します。

javadocのタグ

javadocツールは、次のタグを認識します。

ドキュメントのコメント

スタート後/ **、最初の行または行は、クラス、変数やメソッドの主な説明があります。

この後は、@タグのソートものの一つ以上を含むことができます。 @各タグは新しい行にすること、またはアスタリスク（*）が続く行の先頭から始まらなければなりません。

ラベルの同じタイプの複数のグループに配置する必要があります。 次の3つの@seeタグがある場合、例えば、それらを一つを一つの置くことができます。

以下は、クラスコメントの例を説明します：

/*** This class draws a bar chart.
* @author Zara Ali
* @version 1.2
*/

何javadocの出力

あなたのプログラムの注釈を含む入力、出力、いくつかのHTMLファイルとしてjavadocツールJavaプログラムのソースコード。

情報の各タイプには、HTMLファイル内の一人であろう。 javadocの出力は、ツリーとインデックスを継承することができます。

異なるjavadocの実装作業のために異なる可能性があり、あなたは、あなたのJava開発システムやその他の詳細のバージョンを確認するのJavadocの適切なバージョンを選択する必要があります。

例

以下は簡単な例の使用を説明するコメントです。 その説明の前のプロジェクト、各注釈に注意してください。

javadocの処理後、SquareNumクラスのノートはSquareNum.htmlに記載されています。

import java.io.*;
 
/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
   /**
   * This method returns the square of num.
   * This is a multiline description. You can use
   * as many lines as you like.
   * @param num The value to be squared.
   * @return num squared.
   */
   public double square(double num) {
      return num * num;
   }
   /**
   * This method inputs a number from the user.
   * @return The value input as a double.
   * @exception IOException On input error.
   * @see IOException
   */
   public double getNumber() throws IOException {
      InputStreamReader isr = new InputStreamReader(System.in);
      BufferedReader inData = new BufferedReader(isr);
      String str;
      str = inData.readLine();
      return (new Double(str)).doubleValue();
   }
   /**
   * This method demonstrates square().
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */
   public static void main(String args[]) throws IOException
   {
      SquareNum ob = new SquareNum();
      double val;
      System.out.println("Enter value to be squared: ");
      val = ob.getNumber();
      val = ob.square(val);
      System.out.println("Squared value is " + val);
   }
}

SquareNum.javaファイルを処理するために、javadocツールを使用して、次のように：

$ javadoc SquareNum.java
Loading source file SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: warning - @return tag cannot be used\
                      in method with void return type.
Generating package-frame.html...
Generating package-summary.html...
Generating package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning
$