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

使用 Javadoc 1.5，我无法创建指向枚举值的@链接。

我想要做的是创建一个像这样的 Enum:

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 使用如下链接:

{@link Planet.EARTH}

我也试过 {@link Planet#EARTH}风格，但没有用。

有人知道这是否可行吗？

java
javadoc

48262 次浏览

小开

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

{@link Planet#EARTH}

风格似乎是有效的。然而，我通常更喜欢

@see Planet#EARTH

无论如何。不确定 Eclipse 使用什么来生成 Javadoc，但我使用的是 JDK6。不过，也许“看”对你有用。

小开

最佳答案

#风格适合我:

{@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 上)自动调整你的导入(这意味着如果你有额外的导入没有被使用，他们被删除，以及添加任何你需要的导入)。