如何Javadoc一个类的个人枚举

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

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

但是，这仅仅logging了所有的枚举：

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

在此先感谢您的帮助。

Answer 1

你这样做就像其他variables你会javadoc。

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

编辑：

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

Answer 2

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

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