在doc评论中转义字符和@code标记

时间:2015-02-04 15:05:29

标签: java javadoc

我想把以下一行

{@code object.foo()} is equivalent to {@code Bar.foo(object.baz())}.

在javadoc评论中。 IntelliJ告诉我baz之后的左括号是非法字符,我可以通过写

来消除警告
{@code object.foo()} is equivalent to {@code Bar.foo(object.baz())}.

代替。我用(替换的左括号不是发出警告的左括号。这有效,但我不明白为什么行中只有一个左括号会导致问题。为什么是这样?我什么时候需要写(而不是(

1 个答案:

答案 0 :(得分:0)

这看起来不像有效的Javadoc。您是说Bar中有一个名为foo的函数,它采用object.baz()类型的参数。当然你需要用该方法返回的任何类型替换object.baz()