Làm cách nào để thêm tham chiếu đến một tham số phương thức trong javadoc?

Có cách nào để thêm các tham chiếu đến 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 thức không? 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)
{...}

Theo như tôi có thể nói sau khi đọc các tài liệu cho javadoc thì không có tính năng này.

Đừng sử dụng <code>foo</code>như được đề nghị 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 để biết khi bạn đề cập đến 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>, không phải vậy!

Như bạn có thể 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);
}

Tham chiếu tham số được bao quanh bởi <code></code>các thẻ, điều đó có nghĩa là cú pháp Javadoc không cung cấp bất kỳ cách nào để thực hiện điều đó. (Tôi nghĩ String. Class là một ví dụ điển hình về việc sử dụng javadoc).

Cách chính xác để tham chiếu đến một tham số phương thức là như sau:

Tôi đoán bạn có thể viết doclet hoặc taglet của riêng bạn để hỗ trợ hành vi này.

Tổng quan về Taglet

Tổng quan về tài liệu