如何使用Javadoc链接到枚举值

Question

使用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
}

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

{@link Planet.EARTH}

我也尝试过{@link Planet#EARTH}风格，但无济于事。

有谁知道这是否可行？

Answer 1

#style对我有用：

{@link Planet#EARTH}

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

{@link com.something.somethingelse.Planet#EARTH}

Answer 2

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

{@link Planet#EARTH}

风格似乎有效。 但是，我通常更喜欢

@see Planet#EARTH

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

Answer 3

只要它被导入就可以链接它（但是当你这样做时，IMO会让导入变得混乱 - 代码中使用的是什么以及javadoc中的内容是什么？我喜欢使用完全限定的名称）。

但是，是的，Eclipse可以照顾一切和标准

{@link Planet#EARTH}

工作良好。

如果您使用Eclipse，Ctrl + Shift + O（在PC上）或Cmd + Shift + O（在Mac上）自动调整您的导入（这意味着如果您没有使用额外的导入，它们将被删除，以及添加您需要的任何进口）。