外部仕様への参照。例) URL
クラス
- 関連項目:
-
Effective Java 第2版 (項目70 スレッド安全性を文書化する),
直列化された形式
フィールドの概要 |
static int |
CONST1
定数が意味することを説明する。 |
メソッドの概要 |
int |
function1(int param1,
List list)
publicメソッドにはAPI利用者向けに以下の説明を記述します。 |
protected void |
function2()
protectedメソッドは継承利用者向けにメソッドの内容を説明します。 |
クラス java.lang.Object から継承されたメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CONST1
public static final int CONST1
- 定数が意味することを説明する。例)
Integer.MAX_VALUE
- 関連項目:
- 定数フィールド値
DocSample
public DocSample()
function1
public int function1(int param1,
List list)
throws IOException
- publicメソッドにはAPI利用者向けに以下の説明を記述します。
- パラメータ:
param1
- パラメータの説明。有効な引数の範囲やnullを許容するかを記述します。list
- パラメータに副作用がある場合はその内容を明記する。
- 戻り値:
- 戻り値の説明。戻り値の値の範囲や型、nullの可能性を記述する。
- 例外:
IOException
- 例外の説明。例外の発生原因を記述する。
チェックされる例外はすべて書く。
NullPointerException
- 実行時例外は必要なものだけ記述する。- 関連項目:
- Effective Java 第2版(項目44 すべての公開API要素に対してドキュメントコメントを書く,
項目70 スレッド安全性を文書化する)
function2
protected void function2()
throws IOException
- protectedメソッドは継承利用者向けにメソッドの内容を説明します。
publicメソッドに記述する内容に加えて以下の内容を記述します。
- 例外:
IOException
- チェックされる例外のコメントはサブクラスに自動的に継承されます。
IllegalStateException
- 実行時例外のコメントは手動で継承しなければなりません。
Copyright 2009 技術評論社