1.9.1 メソッドで説明する項目

クラスおよびインターフェースの説明に続けて,そのクラスおよびインターフェースのメソッドを説明しています。上位のインターフェースから継承されるメソッドの詳細については,継承元のインターフェースのメソッドの説明を参照してください。

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

メソッドの機能の詳細を説明しています。

(2) 形式

メソッドの形式を説明しています。複数の形式がある場合,「(a) 形式1」,「(b) 形式2」,「(c) 形式3」などと表記します。

(3) 引数

引数について次のように説明しています。

引数(入力)
指定する値について説明しています。
引数(入出力)
指定した領域に設定される値について説明しています。

(4) 戻り値

メソッドの戻り値を説明しています。戻り値を返却しないメソッドでは,「なし」と記述します。

(5) 例外

発生する例外について説明しています。