Looking for java Answers? Try Ask4KnowledgeBase
Looking for java Keywords? Try Ask4Keywords

Java LanguageJavaコードの文書化


前書き

Javaコードのドキュメントは、 javadocを使用して生成されることがよくあります。 Javadocは、JavaソースコードからHTML形式のAPIドキュメント生成する目的で、Sun Microsystemsによって作成されました。 HTML形式を使用すると、関連する文書を一緒にハイパーリンクすることができるという利便性が得られます。

構文

  • / ** - クラス、フィールド、メソッド、またはパッケージ上のJavaDocの開始
  • @author //クラス、インタフェースまたはenumの作成者に名前を付ける。それは必須です。
  • @version //そのクラス、インタフェース、またはenumのバージョン。それは必須です。ソース管理ソフトウェアがチェックアウト時に記入するために、%I%や%G%のようなマクロを使用することができます。
  • @param //メソッドまたはコンストラクタの引数(パラメータ)を表示する。パラメータごとに@paramタグを1つ指定します。
  • @return // void以外のメソッドの戻り値の型を表示します。
  • @exception //メソッドやコンストラクタからスローされる例外を表示します。捕捉されなければならない例外は、ここにリストされていなければなりません 。必要に応じて、ArrayIndexOutOfBoundsExceptionのように、キャッチする必要のないものも含めることができます。スローできる例外ごとに1つの@exceptionを指定します。
  • @throws // @exceptionと同じです。
  • @see //メソッド、フィールド、クラス、またはパッケージにリンクします。 package.Class#何かの形で使用してください。
  • @since //このメソッド、フィールド、またはクラスが追加されたとき。たとえば、 java.util.Optional <T>のようなクラスのJDK-8です。
  • @serial、@serialField、@serialData // serialVersionUIDを表示するために使用します。
  • @deprecated //クラス、メソッド、またはフィールドを廃止予定としてマークする。たとえば、 java.io.StringBufferInputStreamがあります。既存の廃止予定クラスの完全なリストはこちらをご覧ください
  • {@link} // @seeと似ていますが、カスタムテキストで使うことができます:{@link #setDefaultCloseOperation(int closeOperation)}詳細については、JFrame#setDefaultCloseOperationを参照してください。
  • {@linkplain} //コードフォントがなく、{@link}と似ています。
  • {@code} // HTMLタグなどのリテラルコード。例:{@code <html> </ html>}。しかし、これはモノスペースフォントを使用します。モノスペースフォントなしで同じ結果を得るには、{@literal}を使用してください。
  • {@literal} //モノスペースのフォントを使わずに{@code}と同じです。
  • {@value} //静的フィールドの値を表示します。JFrame#EXIT_ON_CLOSEの値は{@value}です。または、特定のフィールドにリンクすることができます:アプリ名{@value AppConstants#APP_NAME}を使用します。
  • {@docRoot} //現在のファイルを基準にしたJavaDoc HTMLのルートフォルダ。例:<a href="{@docRoot}/credits.html">クレジット</a>
  • HTMLは許可されています:<code> "Hi cookies" .substring(3)</ code>。
  • * / - JavaDoc宣言の終わり

備考

Javadocは、コード内のコメントをHTMLドキュメントに変換できるJDKに含まれているツールです。 Java API仕様は、Javadocを使用して生成されました。サードパーティのライブラリの多くのドキュメントでも同じことが言えます。

Javaコードの文書化 関連する例