使用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的最好方法吗？
回答 3
Stack Overflow用户
发布于 2008-10-12 03:58:53
要回答问题的第一部分，必须用逗号分隔每个枚举值。据我所知，这是没有办法的。
就我个人而言，我对您所呈现的代码方式没有问题。在我看来，这是记录枚举的一种非常合理的方式。
Stack Overflow用户
发布于 2008-10-12 04:42:58
正如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可以配置为自动以这种方式格式化它们。
Stack Overflow用户
发布于 2008-10-12 04:16:02
有一个谷歌代码搜索在线工具-- http://www.google.com/codesearch
我尝试通过执行类似"lang:java public enum"的操作来查找内容
https://stackoverflow.com/questions/195020
复制相似问题
腾讯云开发者
