web-dev-qa-db-ja.com

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
}

次に、次のようなリンクを使用してEarthのJavadocを参照します。

{@link Planet.EARTH}

私は{@link Planet#EARTH}スタイルもありますが、役に立ちません。

これがまったく実行可能かどうかは誰でも知っていますか？

javajavadoc
109
Christer Fahlgren

＃スタイルは私のために働く：

{@link Planet#EARTH}

重要なのは、Planetパッケージをインポートするか、planetを完全に修飾する必要があるということです。つまり：

{@link com.something.somethingelse.Planet#EARTH}
176
aperkins

これを確認するためにEclipseを使用していますが、

{@link Planet#EARTH}

スタイルが機能しているようです。しかし、私は通常好む

@see Planet#EARTH

とにかく。 EclipseがJavadocの生成に使用するものがわかりませんが、私はJDK6を使用しています。それでも、多分@seeがあなたのためのトリックをします。

5
sfussenegger

インポートされている限り、リンクできます（ただし、これを行うと、IMOはインポートを乱雑にします。コードで使用されるものとjavadocで使用されるものは何ですか？完全修飾名を使用したいだけです）。

しかし、はい、Eclipseはすべての標準を処理できます

{@link Planet#EARTH}

正常に動作します。

Eclipseを使用している場合、Ctrl + Shift + O（PCの場合）またはCmd + Shift + O（Macの場合）でインポートを自動調整する（つまり、使用されていない追加のインポートがある場合は削除され、追加される必要なインポート）。

2
Jack