代码之家 › 专栏 › 技术社区 › MetroidFan2002

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

javadoc enums java

MetroidFan2002 · 技术社区 · 16 年前

我发现这个方法是有效的,但是结果代码有点不精确:

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

是否有任何方法可以在不使用逗号链接的情况下分解自己行上的枚举声明,或者这是将JavaDoc用于枚举的最佳方法?

3 回复 | 直到 16 年前

Mike Deck 16 年前

就我个人而言,我对代码的呈现方式没有问题。对我来说,似乎是记录枚举的一种完全合理的方式。

Dov Wasserman 16 年前

正如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都可以配置为以这种方式自动格式化。

-3

Marek Grzenkowicz 13 年前

有一个谷歌代码在线搜索工具-- http://www.google.com/codesearch

"lang:java public enum"

An example from Sun

推荐文章

Stephen.lin · 当鼠标向上移动弹出java文档时,IntelliJ思想如何像eclipse一样工作

6 年前

Vulkanos · 我可以在自定义doclet的帮助下生成Javadoc注释吗?

7 年前

Fraquack · Kotlin-接口方法引发的文档异常

7 年前

Adrien Aacha · Javadocs-@param name未找到

7 年前

Mohan · 为具有(模拟的)可选/默认参数的函数编写Javadoc

7 年前

Jai · vararg方法的Javadoc链接

7 年前

grandouassou · 使用Java Bean验证注释从POJO生成文档

7 年前

drJava · 在JavaDoc中将方法参数与类成员链接

7 年前

Batman · Javadoc和继承的类

8 年前

CrypticStorm · IntelliJ Javadoc每行增加一个星号

10 年前