|
WEB+DB PRESS Vol.51 | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectwebdb51.DocSample
public class DocSample
クラスに対してのコメントを記述します。 ここでは以下の内容を記述します。
File
クラス
Comparable
インタフェース
Appendable
インタフェース
RuntimePermission
クラス
AbstractList
クラス
URL
クラス
フィールドの概要 | |
---|---|
static int |
CONST1
定数が意味することを説明する。 |
private String |
field1
フィールドの説明。 |
コンストラクタの概要 | |
---|---|
DocSample()
|
メソッドの概要 | |
---|---|
int |
function1(int param1,
List list)
publicメソッドにはAPI利用者向けに以下の説明を記述します。 |
protected void |
function2()
protectedメソッドは継承利用者向けにメソッドの内容を説明します。 |
private void |
function3()
package privateメソッド、privateメソッドは保守担当者向けに以下の内容を記述します。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
---|
private String field1
public static final int CONST1
Integer.MAX_VALUE
コンストラクタの詳細 |
---|
public DocSample()
メソッドの詳細 |
---|
public int function1(int param1, List list) throws IOException
Integer.parseInt(String)
String.hashCode()
メソッド
(どのように実装しているかではありません。)
File.getCanonicalPath()
メソッド
param1
- パラメータの説明。有効な引数の範囲やnullを許容するかを記述します。list
- パラメータに副作用がある場合はその内容を明記する。
IOException
- 例外の説明。例外の発生原因を記述する。
チェックされる例外はすべて書く。
NullPointerException
- 実行時例外は必要なものだけ記述する。protected void function2() throws IOException
GenericServlet.init(ServletConfig)
メソッド
Object.equals(Object)
メソッド
IOException
- チェックされる例外のコメントはサブクラスに自動的に継承されます。
IllegalStateException
- 実行時例外のコメントは手動で継承しなければなりません。private void function3()
Class.getSimpleName()
でクラス名を取得する。
|
WEB+DB PRESS Vol.51 | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |