java - 如何 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ŭlo Ebermann:枚举是一个单独的类。您不能在封闭类中包含其完整文档(至少，在不修补标准 doclet 的情况下)。