如何使用Javadoc类的单个枚举

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

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

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

生成的Javadoc

有没有办法单独记录每个HairColor值？无需将枚举移入自己的类或从枚举更改它？

在此先感谢您的帮助。

java enums javadoc

— 雪域编码女孩
source

出于好奇，为什么要这么做？您将枚举列为private嵌套枚举，因此该类的用户无论如何都无法使用该枚举或其值。如果它是公开的和独立的，那么将其记录为自己的单位有什么大不了的？

— 马克·彼得斯

在我的实际代码中，它是公开的。而且您知道公司标准如何。“这会更好”。“太糟糕了，我们对编程一无所知的我们认为您应该这样做”。哈哈

— Snowy Coder Girl

很公平。只要确保告诉他们发行版将推迟一周，因为对文档的不可移动的要求可能永远不会被阅读。这通常会引起那些根本关心公司的人的注意。

— 马克·彼得斯

哈哈。Javadoc尚未像javadoc一样未使用。但是我喜欢编码。一些程序员的方法名与实际发生的事情无关。像getCat一样，返回最近10天内爬树的所有猫，不包括星期二或节假日。哈哈

— Snowy Coder Girl

@RachelG。每个开发人员都认为自己优于其他开发人员是一种很普遍的现象。虽然没有冒犯。

— OddDev

Answers:

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


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

    /**
     * Blue color
     */
    blue

}

编辑：

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

— 489
source

这将生成相同的内容（请注意快照上的链接）。我希望将它们直接放在类javadoc中（而不是链接到另一个javadoc）。但是，谢谢=）+1推进了问题的描述。

— Snowy Coder Girl

@Rachel：枚举是一个单独的类。您不能在封闭的类中包含其完整文档（至少在不修补标准doclet的情况下）。

— 圣保罗Ebermann

是的我有点担心链接发生时的状态。我猜想包括单个枚举的唯一方法是将其更改为一个内部类，然后在那里声明对象并用javadoc对其进行处理。

— Snowy Coder Girl

@ user489041：您能否在答案中加入重要的评论（例如我的评论），以备将来参考？

— 圣保罗Ebermann

如果要引用它，则可以始终使用{@link Color}，甚至可以使用它，{@link Color#red}或者甚至可以{@link #red}在包含任何其他javadoc（包括类javadoc）的同一文档中使用它。

— flungo

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

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}

— 嘘声
source