Java/JavaDoc
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
単語検索
|
最終更新
|
ヘルプ
|
ログイン
]
開始行:
[[Java]]
* ''JavaDoc'' [#k33d40dc]
#contents
* javaDocとは [#gd7607a7]
Javaのクラスの仕様、Javaのメソッドの仕様をjavaのソースか...
※ソースの説明書を出力する機能だと思えば良い。
以下標準のJavadoc
-https://docs.oracle.com/javase/jp/7/api/
* 使い方 [#if94fdc1]
コメントを記述する時に、Javadocタグ、決まった定型文を埋...
- Javadocタグ(一部）
|タグ|記述内容|h
|@author|開発者名を記述する。|
|@deprecated|廃止されたクラス やメソッドに付けられる。|
|@exception|メソッドが投げる例外クラスとその説明を記述す...
|@param|メソッドの引数や総称型のパラメータを記述する。|
|@return|メソッドの戻り値を記述する。|
|@see|関連する他のメソッドまたはクラスを記述する。|
|@since|クラスまたはメソッドの導入されたバージョンを記述...
|@version|クラスまたはメソッドのバージョンを記述する。|
|@serial|デフォルトで直列化可能フィールドのdocコメントで...
- 使用例
#highlighter(java,number){{
/**
* クラスの説明.
* <pre></pre>JavadocにはHTMLタグを使用することができる。
* @param 総称型パラメータの説明
* @param 引数の数だけ指定
* @author 作成者
* @version 1.0
* @since 1.0
*/
public class JavadocSample<T1, T2> {
/**
* 非推奨メソッド。
* @deprecated このメソッドは非推奨です。
* @param t 説明
* @throws 例外の説明
*/
String deprecatedMethod(int t) {
}
/**
* メソッドの説明。
* @param t 説明
* @return String型の値
* @since 1.5
*/
public String add(T1 t) {
return null;
}
}
}}
終了行:
[[Java]]
* ''JavaDoc'' [#k33d40dc]
#contents
* javaDocとは [#gd7607a7]
Javaのクラスの仕様、Javaのメソッドの仕様をjavaのソースか...
※ソースの説明書を出力する機能だと思えば良い。
以下標準のJavadoc
-https://docs.oracle.com/javase/jp/7/api/
* 使い方 [#if94fdc1]
コメントを記述する時に、Javadocタグ、決まった定型文を埋...
- Javadocタグ(一部）
|タグ|記述内容|h
|@author|開発者名を記述する。|
|@deprecated|廃止されたクラス やメソッドに付けられる。|
|@exception|メソッドが投げる例外クラスとその説明を記述す...
|@param|メソッドの引数や総称型のパラメータを記述する。|
|@return|メソッドの戻り値を記述する。|
|@see|関連する他のメソッドまたはクラスを記述する。|
|@since|クラスまたはメソッドの導入されたバージョンを記述...
|@version|クラスまたはメソッドのバージョンを記述する。|
|@serial|デフォルトで直列化可能フィールドのdocコメントで...
- 使用例
#highlighter(java,number){{
/**
* クラスの説明.
* <pre></pre>JavadocにはHTMLタグを使用することができる。
* @param 総称型パラメータの説明
* @param 引数の数だけ指定
* @author 作成者
* @version 1.0
* @since 1.0
*/
public class JavadocSample<T1, T2> {
/**
* 非推奨メソッド。
* @deprecated このメソッドは非推奨です。
* @param t 説明
* @throws 例外の説明
*/
String deprecatedMethod(int t) {
}
/**
* メソッドの説明。
* @param t 説明
* @return String型の値
* @since 1.5
*/
public String add(T1 t) {
return null;
}
}
}}
ページ名:
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
