如何使用 Javadoc 将枚举值@link

java javadoc

2022-08-31 08:02:35

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

{@link Planet.EARTH}

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

有谁知道这是否可行？

答案 1

这种风格对我有用：#

{@link Planet#EARTH}

关键是包必须导入，或者必须完全限定 - 即：PlanetPlanet

{@link com.yourpackage.Planet#EARTH}

答案 2

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

{@link Planet#EARTH}

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

@see Planet#EARTH

无论如何。不知道Eclipse用什么来生成Javadoc，但我使用的是JDK6。不过，也许@see能帮你解决问题。