如何使用Javadoc链接到枚举值

时间:2009-10-05 17:01:57

标签: 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
}

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

{@link Planet.EARTH}

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

任何人都知道这是否可行?

3 个答案:

答案 0 :(得分:166)

#style对我有用:

{@link Planet#EARTH}

关键是必须进口Planet包装,或者行星必须完全合格 - 即:

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

答案 1 :(得分:5)

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

{@link Planet#EARTH}
风格似乎有效。但是,我通常更喜欢

@see Planet#EARTH

反正。不确定Eclipse使用什么来生成Javadoc,但我使用的是JDK6。不过,也许@see为你做了诀窍。

答案 2 :(得分:2)

只要导入它就可以链接它(但是当你这样做时,IMO会让导入混乱 - 代码中使用的是什么以及javadoc中的是什么?我喜欢使用完全限定的名称)。< / p>

但是,是的,Eclipse可以照顾好所有标准

{@link Planet#EARTH}

工作正常。

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