如何 Javadoc 类的单个枚举

enums java javadoc

2022-08-31 11:00:55

我正在为一个包含自己的枚举的类编写Javadoc。有没有办法为各个枚举生成 Javadoc？例如，现在我有这样的东西：

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

但是，这仅将所有枚举作为一个整体来记录：

The generated Javadoc

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

答案 1

你这样做就像javadoc的任何其他变量一样。


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

    /**
     * Blue color
     */
    blue

}

编辑：

来自Paŭlo Ebermann：枚举是一个单独的类。您不能将其完整文档包含在封闭类中（至少，如果不修补标准 doclet）。

答案 2

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

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}