web-dev-qa-db-ja.com

クラスの個々の列挙をJavadocする方法

独自の列挙型を含むクラスのjavadocを作成しています。個々の列挙型のjavadocを生成する方法はありますか？たとえば、今は次のようなものがあります。

/**
 * This documents "HairColor"
 */
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };

ただし、これは列挙型全体を文書化するだけです。

The generated Javadoc

各HairColor値を個別に文書化する方法はありますか？列挙型を独自のクラスに移動したり、列挙型から変更したりしませんか？

助けてくれてありがとう。

javaenumsjavadoc
75
Snowy Coder Girl

Javadocを使用する他の変数と同様に実行します。


/**
 *  Colors that can be used
 */
public enum Color
{
    /**
     * Red color
     */
    red,

    /**
     * Blue color
     */
    blue

}

編集：

PaŭloEbermannから：enumは別のクラスです。 （少なくとも、標準ドックレットにパッチを適用せずに）包含クラスに完全なドキュメントを含めることはできません。

90
user489041

各列挙のアイテムへのリンクを作成できます。すべてのアイテムは、javadocsに列挙クラスにリストされます。

/**
 *  Colors that can be used
 *  <li>{@link #RED}</li>
 *  <li>{@link #BLUE}</li>
 */
public enum Color {

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}
62
shushper