50

我刚刚开始在我自己的项目中使用 Java 的枚举(我必须在工作中使用 JDK 1.4),我对使用 JavaDoc 进行枚举的最佳实践感到困惑。

我发现这种方法有效,但生成的代码有点不完善:

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

有没有什么办法可以在自己的行上分解枚举声明而不用逗号链接它们,或者这是使用 JavaDoc 进行枚举的最佳方法?

4

3 回答 3

32

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

就我个人而言,我对您呈现代码的方式没有任何问题。似乎是向我记录枚举的一种完全合理的方式。

于 2008-10-12T03:58:53.197 回答
14

正如 Mike 所提到的,您必须用逗号分隔枚举值,并且它们必须是枚举声明中列出的第一件事(实例变量、常量、构造函数和方法可能紧随其后)。

我认为记录枚举的最佳方式类似于常规类:枚举类型获取对整个枚举的功能和角色的描述(“ Something values are used to indicate which mode of operation a client wishes...”),并且每个枚举值获取其用途和功能的 Javadoc 描述(“ FIRST_THING indicates that the operation should evaluate the first argument first..”)。

如果枚举值描述很短,您可能希望将它们放在一行中/** Evaluate first argument first. */,但我建议将每个枚举值保留在自己的行中。大多数 IDE 可以配置为自动以这种方式格式化它们。

于 2008-10-12T04:42:57.897 回答
-3

有一个google代码搜索在线工具——http: //www.google.com/codesearch

我尝试通过执行“lang:java public enum”之类的操作来查找内容

Sun 的一个例子

于 2008-10-12T04:16:01.710 回答