如何Javadoc一个类的Individual 枚举

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (15)

我正在为包含它自己的枚举的类编写javadoc。有没有办法为单个枚举生成javadoc?例如,现在我有这样的东西:

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

但是,这仅仅记录了整个枚举:

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

提问于
用户回答回答于

你可以像做任何其他变量那样做javadoc。


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

    /**
     * Blue color
     */
    blue

}

枚举是一个单独的类。你不能在封闭类中包含它的完整文档(至少在不修补标准doclet的情况下)。

用户回答回答于

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

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}

扫码关注云+社区