使用JavaDoc来loggingJava枚举的最佳方式是什么？
我刚刚开始在自己的项目中使用Java的枚举（我必须在工作中使用JDK 1.4），对于将JavaDoc用于枚举的最佳做法我感到困惑。
我发现这个方法是有效的，但是最终的代码有点不确定：
/** * Doc for enum */ public enum Something { /** * First thing */ FIRST_THING, /** * Second thing */ SECOND_THING; //could continue with more } 有没有什么办法可以打破自己的行的枚举声明没有用逗号链接，或者这是使用JavaDoc的枚举最好的方法？
要回答你的问题的第一部分，你必须用逗号分隔每个枚举值。 据我所知，这是没有办法的。
就我个人而言，我不会像你提交代码那样有问题。 似乎是一个完全合理的方式来logging我的枚举。
正如Mike提到的，你必须用逗号分隔枚举值，它们必须是枚举声明中列出的第一件事情（实例variables，常量，构造函数和方法可能遵循）。
我认为logging枚举最好的方法类似于普通类：枚举types整体地描述枚举的function和作用（“ Something values are used to indicate which mode of operation a client wishes... ” ），每个枚举值得到一个Javadoc描述其目的和function（“ FIRST_THING indicates that the operation should evaluate the first argument first.. ”）。
如果枚举值描述很短，则可能需要将它们放在一行中，作为/** Evaluate first argument first. */ /** Evaluate first argument first. */ ，但我build议保持每个枚举值在自己的路线。 大多数IDE可以configuration为自动格式化它们。
