类似的东西:
/**
* 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)
{...}
#1 楼
据我阅读javadoc的文档后所知,没有这样的功能。不要按照其他答案中的建议使用
<code>foo</code>
;您可以使用{@code foo}
。当您引用诸如{@code Iterator<String>}
之类的通用类型时,尤其要知道这一点-肯定看起来比<code>Iterator<String></code>
好,不是吗!#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用法的一个很好的例子。)评论
标记未引用特定参数。它正在将单词“ String”格式化为“看起来代码”文本。
– Naxos84
17 Mar 9 '17 at 6:01
#3 楼
引用方法参数的正确方法是这样的:评论
这不会为现有答案添加任何内容。请删除它。
–suriv
17年1月23日在20:31
它不仅回答了这个问题,而且还直观地解释了如何使用诸如Intellij之类的IDE用参数修改Javadoc。这对于正在寻找答案的搜索者很有用。
– Eurig Jones
17年4月7日在23:32
在Eclipse上不起作用。但这仍然是一个很好的答案
–亨利克·德·索萨(Henrique de Sousa)
17年8月8日在9:38
这应该删除。想象不再存在。
–user4504267
17年11月16日在17:38
@ user4504267图像看起来至少现在还不错。
– ErikE
18年5月30日在16:28
#4 楼
我想您可以编写自己的doclet或taglet来支持此行为。Taglet概述
Doclet概述
评论
并向javadoc发出请求:)
– Juh_
2014年11月5日13:08
评论
@code标记在Javadoc-标记说明中进行了描述。请参阅JDK8代码中的样本用法。
–pba
19-09-6在7:33