使用JavaDoc记录Java枚举的最佳方法是什么？

我刚刚开始在我自己的项目中使用Java的枚举（我必须在工作中使用JDK1.4），我对使用JavaDoc作为枚举的最佳实践感到困惑

我发现这个方法是有效的，但是结果代码有点不精确：

/**
* Doc for enum
*/
public enum Something {
/**
* First thing
*/
FIRST_THING,
/**
* Second thing
*/
SECOND_THING;
//could continue with more
}

---

是否有任何方法可以在不使用逗号链接的情况下将枚举声明拆分为各自的行，或者这是将JavaDoc用于枚举的最佳方法？

要回答问题的第一部分，必须用逗号分隔每个枚举值。据我所知，这是没有办法的

---

就我个人而言，我对代码的呈现方式没有问题。对我来说，似乎是记录枚举的一种非常合理的方式。

有一个谷歌代码在线搜索工具--

我尝试通过以下方式查找内容

---

正如Mike提到的，您必须用逗号分隔枚举值，并且它们必须是枚举声明中列出的第一件事（可能会出现实例变量、常量、构造函数和方法）

我认为记录枚举的最佳方式类似于常规类：枚举类型获取对枚举作为一个整体的功能和角色的描述（“

Something”值用于指示客户端希望采用哪种操作模式…

”），每个枚举值获取其用途和功能的Javadoc描述(“

第一件事指示操作应首先计算第一个参数。

”）

---

如果枚举值描述很短，您可能希望将它们放在一行中，作为

/**首先计算第一个参数。*/

，但我建议将每个枚举值放在自己的行中。大多数IDE可以配置为自动以这种方式格式化它们。

实际上，至少对于JDK1.7（其他未测试的版本），在每个枚举值（包括最后一个枚举值）后面加一个逗号是完全合法的。只要在最后一个值后面的行上加一个分号就可以了。这样可以更轻松地移动值或添加/删除值，而不必担心使用逗号或分号。