自分用メモ

Seasar2 Javadoc

MLから取り残されつつあるので、自分用メモ。

  • @authorに書く自分の名前

Javadocに自分の名前を追記するときは、名前の後に(Javadoc)を追記する。

/**
 * ここは省略
 * @author higa
 * @author nomadmonad(Javadoc)
 */
  • @throwsの記述方針

インターフェースで例外を記述するときは、実装クラス側でスローする可能性のある例外をすべて記述する。

  • <code>の使うタイミング（引数の場合）

メソッドの説明文で特定の引数を表す場合、<code>を使って記述する。

  • @linkと<code>の使い分け

@linkと<code>は併用しない。@linkだけでOK。

×：<code>{@link hoge}</code>
○：{@link hoge}
  • 修飾名と非修飾名

同じパッケージに属するクラスを記述する場合、非修飾名は使わない。クラス名だけでOK。

×：org.seasar.framework.container.MetaDef
○：MetaDef