메소드 문서 본문에서 하나 이상의 메소드 매개 변수에 대한 참조를 추가하는 방법이 있습니까? 다음과 같은 것 :
/**
* 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)
{...}
답변
javadoc에 대한 문서를 읽은 후에 알 수있는 한 그러한 기능은 없습니다.
<code>foo</code>다른 답변에서 권장 하는 대로 사용하지 마십시오 . 사용할 수 있습니다 {@code foo}. 이것은 {@code Iterator<String>}다음 과 같은 일반 유형을 참조 할 때 특히 유용 <code>Iterator<String></code>합니다.
답변
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 사용법의 좋은 예라고 생각합니다).
