Cách thêm tham chiếu vào tham số phương thức trong javadoc?

Question

Có cách nào để thêm tham chiếu vào một hoặc nhiều tham số của phương thức từ phần thân tài liệu phương pháp không? Một cái gì đó như:

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

Theo như tôi có thể biết sau khi đọc the docs for javadoc, không có tính năng nào như vậy.

Không sử dụng <code>foo</code> như được đề xuất trong các câu trả lời khác; bạn có thể sử dụng {@code foo}. Điều này đặc biệt tốt khi biết khi bạn tham khảo một loại chung chung như {@code Iterator<String>} - chắc chắn trông đẹp hơn <code>Iterator&lt;String&gt;</code>, phải không!

Answer 2

Tôi đoán bạn có thể viết doclet hoặc thẻ nhỏ để hỗ trợ hành vi này.

Taglet Overview

Doclet Overview

Answer 3

Như bạn có thể nhìn thấy trong nguồn Java của lớp 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); 
} 

tài liệu tham khảo thông số được bao quanh bởi <code></code> thẻ, có nghĩa là Cú pháp Javadoc không cung cấp bất kỳ cách nào để làm một điều như vậy. (Tôi nghĩ String.class là một ví dụ tốt về cách sử dụng javadoc).

Answer 4

Cách đúng đề cập đến một số phương pháp là như thế này: