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

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (7)

我刚开始在自己的项目中使用Java的枚举(我必须在工作中使用JDK 1.4),并且对于将JavaDoc用于枚举的最佳做法感到困惑。

我发现这个方法有效,但最终的代码有点不确定:

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

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

提问于
用户回答回答于

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

就我个人而言,我不会像你提交代码一样对代码有任何问题。看起来像一个完全合理的方式来记录我的枚举。

用户回答回答于

你必须用逗号分隔枚举值,并且它们必须是枚举声明中列出的第一件事(实例变量,常量,构造函数和方法可以遵循)。

我认为记录枚举的最好方式类似于常规类:枚举类型整体地描述了枚举的功能和角色(“ 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可以配置为自动以这种方式格式化它们。

扫码关注云+社区