[seasar-javadoc:72] 参考資料(タグの記述順)

[Hideaki Suzuki]

鈴木(belltree)です。

Javadocタグの記述順に関して参考になるのでは？と思い、
「The Elements of Java Style」の中のJavadocサンプルの一部
を書いてみました。こうゆうのがあると迷いが減ります。(^^;;;;;

これをベースに、いらないタグを省いて、Javadoc Wiki に載せる
というのはどうでしょうか？

・クラス＆インターフェース記述
/**
 * Description.
 *
 * @author
 * @version
 * 
 * @see
 * @since
 * @depricated
 */

・メソッド記述
/**
 * Description.
 *
 * @param
 * @return
 * @exception
 * 
 * @see
 * @since
 * @depricated
 */

・フィールド記述
/**
 * Description.
 * 
 * @see
 * @since
 * @depricated
 */

・@seeの順番
/**
 * Description.
 * 
 * @see #field
 * @see #Constructor()
 * @see #Constructor(Type…)
 * @see #method()
 * @see #method(Type…)
 * @see #Class
 * @see Class#field
 * @see Class#Constructor()
 * @see Class#Constructor(Type…)
 * @see Class#method()
 * @see Class#method(Type…)
 * @see #Class
 * @see package.Class#field
 * @see package.Class#Constructor()
 * @see package.Class#Constructor(Type…)
 * @see package.Class#method()
 * @see package.Class#method(Type…)
 * @see package
 * @see <a href="URL#label">label</a>"
 * @see "String"
 * …
 */

/** 
 * @auther Hideaki Suzuki
 * @contact suzuki at uinet.or.jp
 */