如何使用Javadoc @链接到枚举值
使用Javadoc 1.5,我一直无法创build@链接到枚举值。
我想要做的是创build一个像这样的枚举:
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}
风格,但无济于事。
任何人都知道这是可行的吗?
#风格适合我:
{@link Planet#EARTH}
关键是Planet包必须是import的,否则行星必须是完全合格的,即:
{@link com.something.somethingelse.Planet#EARTH}
我使用Eclipse来检查这个,但是
{@link Planet#EARTH}
风格似乎工作。 不过,我通常喜欢
@see Planet#EARTH
无论如何。 不知道Eclipse用来生成Javadoc,但我使用的是JDK6。 不过,也许@see为你做了诡计。
只要它被导入,你可以链接它(但是当你这样做的时候,IMO会导致导入混乱 – 在代码中使用什么,在javadoc中使用什么?我喜欢使用完全限定的名称)。
但是,是的,Eclipse可以照顾到这一切和标准
{@link Planet#EARTH}
工作正常。
如果您使用Eclipse,Ctrl + Shift + O(在PC上)或Cmd + Shift + O(在Mac上)自动调整您的导入(这意味着如果您有额外的导入未使用,它们被删除,以及添加任何你需要的import)。