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

Question

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

我发现这个方法可行，但是生成的代码有点不完善:

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

有没有什么方法可以在不使用逗号链接的情况下将枚举声明拆分到它们自己的行中，或者这是将 JavaDoc 用于枚举的最佳方法？

Answer 1

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

就我个人而言，我对您提供的代码没有问题。似乎是向我记录枚举的一种非常合理的方式。