javadocのメソッドパラメータへの参照を追加するには？

Question

メソッドドキュメンテーション本体から1つまたは複数のメソッドのパラメータへの参照を追加する方法はありますか？ のような何か：

/** 
* When {@paramref a} is null, we rely on b for the discombobulation. 
* 
* @param a this is one of the parameters 
* @param b another param 
*/ 
void foo(String a, int b) 
{...} 

Answer 1

私が読むことができる限り、the docs for javadocにはそのような特徴はありません。

<code>foo</code>を他の回答で推奨されているように使用しないでください。 {@code foo}を使用できます。これは、{@code Iterator<String>}のようなジェネリックタイプを参照する際には特に便利です。確かに<code>Iterator&lt;String&gt;</code>よりもよさそうですね。

Answer 2

私はあなたがこの動作をサポートする独自のドックレットやタグレットを記述することができると思います。

Taglet Overview

Doclet Overview

Answer 3

あなたはjava.lang.StringクラスのJavaソースで見ることができるように：ということ

/** 
* Allocates a new <code>String</code> that contains characters from 
* a subarray of the character array argument. The <code>offset</code> 
* argument is the index of the first character of the subarray and 
* the <code>count</code> argument specifies the length of the 
* subarray. The contents of the subarray are copied; subsequent 
* modification of the character array does not affect the newly 
* created string. 
* 
* @param  value array that is the source of characters. 
* @param  offset the initial offset. 
* @param  count the length. 
* @exception IndexOutOfBoundsException if the <code>offset</code> 
*    and <code>count</code> arguments index characters outside 
*    the bounds of the <code>value</code> array. 
*/ 
public String(char value[], int offset, int count) { 
    if (offset < 0) { 
     throw new StringIndexOutOfBoundsException(offset); 
    } 
    if (count < 0) { 
     throw new StringIndexOutOfBoundsException(count); 
    } 
    // Note: offset or count might be near -1>>>1. 
    if (offset > value.length - count) { 
     throw new StringIndexOutOfBoundsException(offset + count); 
    } 

    this.value = new char[count]; 
    this.count = count; 
    System.arraycopy(value, offset, this.value, 0, count); 
} 

パラメータ参照は<code></code>タグで囲まれています、 Javadoc構文は、そのようなことを行う方法を提供していません。 （私はString.classはjavadocの使い方の良い例だと思う）。

Answer 4

メソッドのパラメータを参照する正しい方法は、このようなものです：