のJavadocバグ：@linkはジェネリック医薬品を扱うことができない「<>」

Question

は私がjavadocを使用して、それを文書化しているクラスの静的メソッドを、考えてみましょう：

/** 
* Description here. 
* 
* @param names  - The parameters of the impression request. 
* @param ids   - An intent object to enrich. 
* @param prefix - A prefix. 
*/ 

public static void parse(Map<String, String> names, String ids, String prefix) 
    ... 

、オーバーロードで説明の重複を避けるために、

/** 
* Overloaded version with default prefix. 
* {@link #<parse(Map<String, String>, String, String)> [Text]} 
*/ 

public static void parse(Map<String, String> names, String ids, String prefix) 

次の警告提供します：

@link:illegal character: "60" in "#parseBtCategories(Map<String, String>, 
                String, String) Text" 

の方法のバージョンでは、私は、javadocの @linkを使用したいです

ASCII 60は<です。これはメソッドシグネチャの一部です。 Map, String, String)ナットで動作します。この表記は、2つの異なるタイプのマップを区別できません。

This seems to be a known bug.回避策はありますか？

Answer 1

パラメータ化された型は、メソッドの署名の一部ではありません。

GenericsとType Erasureとを実装しています。 concept of Type Erasureは、generic typesがコンパイル時にのみ利用可能であり、その時点でそれらは「消去」されているということです。クラスのバイトコードから削除されたことを意味します。したがって、実行時にアクセスできないですとはメソッドの署名の一部ではありません。

だから、あなたは同じ生タイプに解決ジェネリック型を持つ2つのメソッドをオーバーロードすることはできませんので、それらは、Javadocのリンクの署名の一部であることには本当の理由はありません。で、一般的なタイプのあいまいさがあることはできませんあなたのソースの署名。

さらに、JavadocはHTMLタグをサポートしており、私は、これはそれがここにホコリを噛むもう一つの理由かもしれないと仮定し、私は実際のJavadoc処理ツールは、このひどく実施された疑い。 デビッド・コンラッドソリューションと同様に

Answer 2

は、次の構文を使用して、リンクの説明として、完全な署名を使用することができます。

{@link class#method(signature) text-to-display} 

は<と>をエスケープすることを忘れないでください。

{@link #parse(Map, String, String) parse(Map<String, String>, String, String)} 

Answer 3

は、それはあなたが探しているものではないかもしれないが、私は{RfRequestSummaryDto @link}の * @return {@linkリスト}のようなもの