javadoc의 메소드 매개 변수에 대한 참조를 추가하는 방법은 무엇입니까?

Question

메서드 문서 본문에서 메서드 매개 변수 중 하나 이상에 대한 참조를 추가하는 방법이 있습니까? 뭔가 같은 :

/** 
* 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 클래스의 자바 소스에서 볼 수 있듯이 다음을 의미

/** 
* 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

방법 매개 변수를 참조의 올바른 방법은 다음과 같이이다 :