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

20 浏览
0 Comments

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

我刚开始在我的项目中使用Java的枚举(我必须在工作中使用JDK 1.4),我对于如何最佳实践使用JavaDoc来描述枚举感到困惑。

我发现以下方法可以实现,但结果代码有些粗糙:

/**
* 枚举的文档
*/
public enum Something {
/**
* 第一件事
*/
FIRST_THING,
/**
* 第二件事
*/
SECOND_THING;
//可以继续添加更多
}

我是否有办法将枚举声明分行而不通过逗号连接它们,或者这是使用JavaDoc描述枚举的最佳方法?

0