如何Javadoc一个类的个人枚举

Question

我正在为包含它自己的枚举的类编写javadoc.有没有办法为各个枚举生成javadoc？例如,现在我有这样的事情:

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

但是,这仅记录了所有枚举:

有没有办法单独记录每个HairColor值？没有将枚举移入自己的类或从枚举中更改它？

在此先感谢您的帮助.

Answer 1

你就像javadoc的任何其他变量一样.

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

    /**
     * Blue color
     */
    blue

}

编辑:

来自PaŭloEbermann:enum是一个单独的类.您不能在封闭类中包含其完整文档(至少在不修补标准doclet的情况下).

Answer 2

您可以创建每个枚举项目的链接.所有项目都将在javadocs中列出到枚举类.

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}