使用 JavaDoc 记录 Java 枚举的最佳方法是什么?
我刚刚开始在我自己的项目中使用Java的枚举(我必须在工作中使用JDK 1.4),我对使用JavaDoc作为枚举的最佳实践感到困惑。
我发现这种方法有效,但生成的代码有点不精致:
/**
* Doc for enum
*/
public enum Something {
/**
* First thing
*/
FIRST_THING,
/**
* Second thing
*/
SECOND_THING;
//could continue with more
}
有没有办法在不用逗号链接的情况下将枚举声明分解在它们自己的行上,或者这是使用JavaDoc进行枚举的最佳方法吗?