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

2022-08-31 21:04:06

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

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

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

有没有办法在不用逗号链接的情况下将枚举声明分解在它们自己的行上,或者这是使用JavaDoc进行枚举的最佳方法吗?


答案 1

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

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


答案 2

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

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

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