如何使用Javadoc链接到枚举值

Chr*_*ren 112 java javadoc

使用Javadoc 1.5,我无法创建枚举值的@link.

我想做的是创建一个这样的枚举:

public enum Planet { 

/**
* MERCURY is a fun place.
*/
MERCURY, 

/**
* VENUS is more fun.
*/
VENUS, 

/**
* But nothing beats the Earth.
*/
EARTH,

/**
* Others we know nothing about.
*/ 
OTHERS
}
Run Code Online (Sandbox Code Playgroud)

然后使用以下链接引用Javadoc for Earth:

{@link Planet.EARTH}
Run Code Online (Sandbox Code Playgroud)

我也试过这种{@link Planet#EARTH}风格,但无济于事.

有谁知道这是否可行?

ape*_*ins 180

#style对我有用:

{@link Planet#EARTH}
Run Code Online (Sandbox Code Playgroud)

关键是必须导入Planet包,否则行星必须完全合格 - 即:

{@link com.yourpackage.Planet#EARTH}
Run Code Online (Sandbox Code Playgroud)

  • 如果枚举在A类中定义,并且有人试图从类B javadoc引用其中一个值,该怎么办?我发现A.Planet#EARTH和A#Planet#EARTH都不适用于OpenJDK 1.6更新24 javadoc,虽然eclipse知道用A.Planet #EARTH风格找到声明. (3认同)

sfu*_*ger 6

我正在使用Eclipse来检查这个,但是

{@link Planet#EARTH}
Run Code Online (Sandbox Code Playgroud)

风格似乎有效.但是,我通常更喜欢

@see Planet#EARTH
Run Code Online (Sandbox Code Playgroud)

无论如何.不确定Eclipse使用什么来生成Javadoc,但我使用的是JDK6.不过,也许@see为你做了诀窍.

  • 我喜欢`@ see`,但有时你需要特殊情况.例如,我的订单有一个`isWithdrawn()`方法,我特别说`@return如果此订单的状态等于OrderStatus#WITHDRAWN则为true,否则为false (4认同)