簡體   English   中英

如何使用Javadoc鏈接到枚舉值

[英]How to @link to a Enum Value using 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}風格,但無濟於事。

有誰知道這是否可行?

#style對我有用:

{@link Planet#EARTH}

關鍵是必須導入Planet包,否則行星必須完全合格 - 即:

{@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上)自動調整您的導入(這意味着如果您沒有使用額外的導入,它們將被刪除,以及添加您需要的任何進口)。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM