如何使用Javadoc@链接到枚举值

如何使用Javadoc@链接到枚举值,java,javadoc,Java,Javadoc,使用JavaDoc1.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 } {@link

使用JavaDoc1.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
}
{@link Planet.EARTH}
然后使用如下链接参考Javadoc for Earth:

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
}
{@link Planet.EARTH}
我也尝试过
{@link Planet#EARTH}
风格,但没有效果


有人知道这是否可行吗?

我正在使用Eclipse检查这一点,但是

{@link Planet#EARTH}
这种风格似乎很管用。不过,我通常更喜欢

@see Planet#EARTH
无论如何。不确定Eclipse使用什么来生成Javadoc,但我使用的是JDK6。不过,也许@see能帮你解决问题。

这种
#
风格适合我:

{@link Planet#EARTH}
关键是必须导入
Planet
软件包,或者
Planet
必须完全合格-即:

{@link com.yourpackage.Planet#EARTH}

只要它被导入,你就可以链接它(但是当你这么做的时候,IMO会把导入弄得一团糟——代码中使用的是什么,javadoc中使用的是什么?我喜欢使用完全限定的名称)

但是,是的,Eclipse可以处理所有这一切,而且是标准的

{@link Planet#EARTH}
很好


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

正如Sfussenger所指出的,Eclipse会为您处理导入。感谢这两个答案的帮助!我确实使用了完全合格的参考资料。有时,编译器输出在确定问题是什么方面并没有真正的帮助……如果enum是在类A中定义的,并且有人试图从类B javadoc引用它的一个值,该怎么办?我没有发现A.Planet#EARTH和A#Planet#EARTH可以为OpenJDK 1.6 update 24 javadoc工作,尽管eclipse知道可以找到带有A.Planet#EARTH样式的声明。不幸的是,如果静态导入enum,则这不起作用。至少在intellij idea中,没有办法在javadoc中使用静态导入的枚举,除非在包等中使用完全限定的枚举名。我喜欢
@see
,但有时需要特殊情况。例如,我的订单有一个
isdeculled()
方法,我特别说
@如果此订单的状态等于OrderStatus#deculled,则返回true,否则返回false