javadocのメソッドパラメータへの参照を追加する方法


313

メソッドのドキュメント本文からメソッドの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)
{...}

回答:


367

javadocのドキュメントを読んだ後、私が知る限り、そのような機能はありません。

<code>foo</code>他の回答で推奨されているとおりに使用しないでください。使用できます{@code foo}。これはあなたのようなジェネリック型を参照する際に知っておく特に良いです{@code Iterator<String>}よりも進歩してくださいルックス- <code>Iterator&lt;String&gt;</code>、それはしません!


@codeタグについては、Javadoc-タグの説明で説明しています。JDK8コードでの使用例を参照してください。
pba

59

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の使用法の良い例だと思います)。


5
<code> </ code>タグは特定のパラメーターを参照していません。「文字列」という単語を「コード探し」テキストにフォーマットしています。
Naxos84 2017年

46

メソッドパラメータを参照する正しい方法は次のとおりです。

ここに画像の説明を入力してください


2
これは既存の回答に何も追加しません。削除してください。
suriv

27
それは質問に答えるだけでなく、IntellijなどのIDEを使用してパラメーターでJavadocを修正する方法を視覚的に説明します。これは、答えを探している検索者に役立ちます。
Eurig Jones 2017

1
Eclipseでは機能しません。しかし、それでも良い答えです
Henrique de Sousa

2
これは削除する必要があります。もはや存在しないと想像してください。
user4504267 2017年

2
@ user4504267画像は、少なくとも今は問題なく見えます。
ErikE 2018年

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.