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

Java 言語は 3 種類のコメントをサポートします −

Sr.No.	コメントと説明
1	/* テキスト */ コンパイラは /* から */ までのすべてを無視します。
2	//テキスト コンパイラは // から行末まですべてを無視します。
3	/** ドキュメント */ これはドキュメント コメントであり、一般に ドキュメント コメント と呼ばれます。 . JDK javadoc ツールは ドキュメント コメント を使用します 自動生成されたドキュメントを準備するとき。

この章では、Javadoc について説明します。 Javadoc を利用して、Java コードの有用なドキュメントを生成する方法を見ていきます。

Javadoc とは

Javadoc は JDK に付属するツールであり、事前定義された形式のドキュメントを必要とする Java ソース コードから HTML 形式の Java コード ドキュメントを生成するために使用されます。

以下は、/*….*/ 内の行が Java の複数行コメントである簡単な例です。同様に、// の前の行は Java の単一行コメントです。

例

/**
* The HelloWorld program implements an application that
* simply displays "Hello World!" to the standard output.
*
* @author  Zara Ali
* @version 1.0
* @since   2014-03-31 
*/
public class HelloWorld {

   public static void main(String[] args) {
      // Prints Hello, World! on standard output.
      System.out.println("Hello World!");
   }
}

説明部分に必要な HTML タグを含めることができます。たとえば、次の例では、見出しに

....

を使用し、段落区切りの作成に

を使用しています -

例

/**
* <h1>Hello, World!</h1>
* The HelloWorld program implements an application that
* simply displays "Hello World!" to the standard output.
* <p>
* Giving proper comments in your program makes it more
* user friendly and it is assumed as a high quality code.
* 
*
* @author  Zara Ali
* @version 1.0
* @since   2014-03-31 
*/
public class HelloWorld {

   public static void main(String[] args) {
      // Prints Hello, World! on standard output.
      System.out.println("Hello World!");
   }
}

javadoc タグ

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

タグ	説明	構文
@author	クラスの作成者を追加します。	@著者名テキスト
{@code}	テキストを HTML マークアップまたはネストされた javadoc タグとして解釈せずに、コード フォントでテキストを表示します。	{@コード テキスト}
{@docRoot}	生成されたページから生成されたドキュメントのルート ディレクトリへの相対パスを表します。	{@docRoot}
@deprecated	この API を使用しないことを示すコメントを追加します。	@deprecated deprecatedtext
@例外	投げを追加 クラス名と説明テキストを含む、生成されたドキュメントへの小見出し。	@例外クラス名の説明
{@inheritDoc}	最も近いからコメントを継承します 継承可能なクラスまたは実装可能なインターフェース。	直属の上位クラスからコメントを継承します。
{@link}	指定されたパッケージ、クラス、または参照されたクラスのメンバー名のドキュメントを指す表示テキスト ラベルを含むインライン リンクを挿入します。	{@link package.class#member label}
{@linkplain}	リンクのラベルがコード フォントではなくプレーン テキストで表示される点を除いて、{@link} と同じです。	{@linkplain package.class#member label}
@param	指定されたパラメーター名の後に指定された説明が続くパラメーターを「パラメーター」セクションに追加します。	@param パラメータ名の説明
@return	説明テキストを含む「返品」セクションを追加します。	@返品の説明
@see	参照を指すリンクまたはテキスト エントリを含む「関連項目」見出しを追加します。	@リファレンスを参照
@シリアル	デフォルトのシリアル化可能なフィールドのドキュメント コメントで使用されます。	@serial フィールドの説明 |含める |除外
@serialData	writeObject( ) または writeExternal( ) メソッドによって書き込まれたデータを文書化します。	@serialData データの説明
@serialField	ObjectStreamField コンポーネントをドキュメント化します。	@serialField フィールド名 フィールドタイプ フィールド説明
@since	生成されたドキュメントに、指定された since-text を含む "Since" 見出しを追加します。	@since release
@throws	@throws タグと @exception タグは同義語です。	@throws クラス名の説明
{@value}	静的フィールドのドキュメント コメントで {@value} を使用すると、その定数の値が表示されます。	{@value package.class#field}
@バージョン	-version オプションを使用すると、生成されたドキュメントに、指定されたバージョン テキストを含む「バージョン」小見出しを追加します。	@version version-text

例

次のプログラムでは、ドキュメントのコメントに使用できる重要なタグをいくつか使用しています。要件に基づいて他のタグを使用できます。

AddNum クラスに関するドキュメントは HTML ファイル AddNum.html で作成されますが、同時に index.html という名前のマスター ファイルも作成されます。

import java.io.*;

/**
* <h1>Add Two Numbers!</h1>
* The AddNum program implements an application that
* simply adds two given integer numbers and Prints
* the output on the screen.
* <p>
* <b>Note:</b> Giving proper comments in your program makes it more
* user friendly and it is assumed as a high quality code.
*
* @author  Zara Ali
* @version 1.0
* @since   2014-03-31
*/
public class AddNum {
   /**
   * This method is used to add two integers. This is
   * a the simplest form of a class method, just to
   * show the usage of various javadoc Tags.
   * @param numA This is the first paramter to addNum method
   * @param numB  This is the second parameter to addNum method
   * @return int This returns sum of numA and numB.
   */
   public int addNum(int numA, int numB) {
      return numA + numB;
   }

   /**
   * This is the main method which makes use of addNum method.
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */

   public static void main(String args[]) throws IOException {
      AddNum obj = new AddNum();
      int sum = obj.addNum(10, 20);

      System.out.println("Sum of 10 and 20 is :" + sum);
   }
}

ここで、次のように javadoc ユーティリティを使用して上記の AddNum.java ファイルを処理します −

$ javadoc AddNum.java
Loading source file AddNum.java...
Constructing Javadoc information...
Standard Doclet version 1.7.0_51
Building tree for all the packages and classes...
Generating /AddNum.html...
AddNum.java:36: 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...
1 warning
$

ここで生成されたすべてのドキュメントを確認できます-AddNum. JDK 1.7 を使用している場合、javadoc は優れた stylesheet.css を生成しません であるため、https://docs.oracle.com/javase/7/docs/api/stylesheet.css から標準スタイルシートをダウンロードして使用することをお勧めします