如何 Javadoc 类的单个枚举

Question

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

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

但是，这仅记录了所有枚举的整体：

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

原文由 Snowy Coder Girl 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

您可以像使用 javadoc 的任何其他变量一样进行操作。

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

    /**
     * Blue color
     */
    blue

}

编辑：

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

原文由 user489041 发布，翻译遵循 CC BY-SA 3.0 许可协议

Answer 2

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

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}

原文由 shushper 发布，翻译遵循 CC BY-SA 4.0 许可协议