のJavadocリンク

Question

現在、私は、このJavadocの構文を持つ他のクラスのメソッド参照している：

@see {@link com.my.package.Class#method()} 

そして、私はこれがこれを行うには正しい方法でドキュメントから理解するものでは。しかし今、面白い部分に、またはイライラする。私は、このJavadocを生成するとき、私は最初にすべての次のエラーを取得：

warning - Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}" 
warning - Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}" 
warning - Tag @see: reference not found: {@link com.my.package.Class#method()} 

はこの生成されたHTMLコードは次のとおりです。

"," <code>com.my.package.Class#method()}</code> "," 

そしてもちろん、私はリンクを持っていません。 誰でも何が起こっているのか、これを修正する方法のヒントを教えてもらえますか？

woldのASCIIテーブル文字123と64は、{と@を表しているため、この構文がドキュメントに基づいて正しい場合、なぜこれらの文字が有効でないのですか？

Answer 1

Javadocタグ@seeの場合は、@linkを使用する必要はありません。 Javadocはあなたのためのリンクを作成します。別に@seeから

@see com.my.package.Class#method() 

Here's more info about @see.

Answer 2

を試してみて、別のクラスに参照のうえ、おそらくそのクラスのメソッドのより一般的な方法は{@link somepackage.SomeClass#someMethod(paramTypes)}です。これは、javadocの記述の途中で使用できるという利点があります。

javadoc documentation (description of the @link tag)：

This tag is very simliar to @see – both require the same references and accept exactly the same syntax for package.class#member and label. The main difference is that {@link} generates an in-line link rather than placing the link in the "See Also" section. Also, the {@link} tag begins and ends with curly braces to separate it from the rest of the in-line text.

Answer 3

ので、元の問題を解決するには、あなたが同じの「@see」と「{@link ...}」の参照の両方を必要としないということですライン。 "@link"タグは自立しており、javadocブロックのどこにでも置くことができます。したがって、2つのアプローチを混在させることができます：

/** 
* some javadoc stuff 
* {@link com.my.package.Class#method()} 
* more stuff 
* @see com.my.package.AnotherClass 
*/