Javadocの外部URLにリンクしていますか?


回答:


1225

これにより、リンクを含む「関連項目」の見出しが作成されます。

/**
 * @see <a href="http://google.com">http://google.com</a>
 */

次のようにレンダリングされます:

参照:http :
           //google.com

これに対して:

/**
 * See <a href="http://google.com">http://google.com</a>
 */

インラインリンクを作成します。

http://google.com参照


59
私はちょうどそれを見ていたので、誰もが、興味を持っている場合は、次によると仕様のJavadoc@seeタグくる@param /の@returnタグと前に@since / @serial/ @deprecatedタグ。
friederbluemle 2013年

7
念のため、Intellij 13はこのタグをサポートしていないようです。インラインリンクはサポートされています。タグはどういうわけか廃止されていますか?
ティモ14

24
私はお勧め<a href="http://google.com" target="_top">http://google.com</a>. 生成されたJavadoc HTMLファイルの一部がフレームの使用を作り、あなたはおそらく、ナビゲーションがページ全体だけではなく、現在のフレームに影響を与えるようにしたいので、ターゲット=「_トップ」を追加するための理由があります。
アントニー

3
「warning-Tag \ @see:missing final '>':」のような警告が表示される場合は、同じ\ @seeディレクティブに2つのハイパーリンクがないことを確認してください。代わりに、\ @ seeごとに1つのリンクを使用します。
Travis Spencer

7
javadocにURLリンクを追加するのがなぜそれほど複雑なのですか?HTMLは良いアイデアだと思った人は... / facepalm
誰かのどこか

189

javadoc仕様からの引用

@see <a href="URL#value">label</a>:で定義されたリンクを追加しURL#valueます。URL#value相対または絶対URLです。Javadocツールは、より小記号(<)を最初の文字として探すことにより、これを他のケースと区別します。

例えば ​​: @see <a href="http://www.google.com">Google</a>


奇妙な; 私はバッククォートにのみ追加したことを誓います。例がどこに行ったのかわかりません...
Stobor 2009

なんらかの同時編集の問題があったと思います。私もそれらを入れていました。
アーロン

けっこうだ。ただし、
ブロック

27
@seeは必要ありません。javadocsはhtmlタグでフォーマットできるため、「a」タグのみが必要です。
ガブリエルラマ

5
@GabrielLlamas正しいですが、元の質問は、これがどのように使用されているかを示しています。それは、具体的ということを知っておくと便利です、多くの人々がそれを望むする場所であることがわかり、またフィールドで仕事を。
イオノクラストブリガム

33

Javadocは外部リンク用の特別なツールを提供していないため、標準のHTMLを使用する必要があります。

See <a href="http://groversmill.com/">Grover's Mill</a> for a history of the
Martian invasion.

または

@see <a href="http://groversmill.com/">Grover's Mill</a> for a history of 
the Martian invasion.

使用しないでください{@link ...}または{@linkplain ...}、これらは他のクラスとメソッドのJavadocをリンクするためのものであるため。



4

Oracleサイトから明確な答えを見つけるのは難しい。以下はからjavax.ws.rs.core.HttpHeaders.javaです:

/**
 * See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">HTTP/1.1 documentation</a>}.
 */
public static final String ACCEPT = "Accept";

/**
 * See {@link <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.2">HTTP/1.1 documentation</a>}.
 */
public static final String ACCEPT_CHARSET = "Accept-Charset";

<a>htmlタグをでラップすることの意味は何{@link ...}ですか?
Patrick M

2
これはおそらく間違いです。javadocのドキュメントではこのフォームについて言及しておらず、rawとの違いがないため<a>です。
Didier L

4
ここの{@link xxx}は正しくありません。{@link xxx}は、ソースコード内の他のクラスやメソッドにリンクするためのものです。ここでは不要です。残りは問題ありません。
MiguelMunoz

4
この構成は、Java 8標準(doclint on)では許可されていません。
Stepan Vavra、2015年

1
これは明らかに間違っています。参照ドキュメントによる正しい使用法は{@link package.class#member label}
次のとおり
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.