如何在javadoc中添加对方法参数的引用？

有没有办法从方法文档体中添加对一个或多个方法参数的引用？ 就像是：

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

据我所知，在阅读了javadoc的文档后，没有这样的function。

不要像其他答案中推荐的那样使用<code>foo</code> ; 你可以使用{@code foo} 。 当您引用genericstypes（例如{@code Iterator<String>} ）时确实比<code>Iterator&lt;String&gt;</code>好看，这是特别好的。

Answer 2

正如你可以在java.lang.String类的Java Source中看到的那样：

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

引用方法参数的正确方法是这样的：

Answer 4

我想你可以编写自己的doclet或小标签来支持这种行为。

Taglet概述

Doclet概述