Javadoc - 带注释的多行注释(@符号)

时间:2013-11-29 14:33:21

标签: annotations javadoc

基于答案:Multiple line code example in Javadoc comment我想编写以下javadoc(在课程级别上)。

/**
 * Whatever txt1 ...
 * <pre>
 * {@code
 *  @Lob
 *  private byte[] foo;
 * }
 * </pre>
 * Whatever txt2 ...
 * 
 * @author $Author: $
 */
public class Foo {

然而它渲染像这样(在eclipse预览中):

Whatever txt1 ...


Author:
 $Author: $
@Lob
private byte[] foo;
 }

Whatever txt2 ...

请注意作者注释的混乱顺序

知道什么是适当的格式/如何正确地设置@符号?

一如既往:

/**
 * Whatever txt1 ...
 * <pre>
 * {@code
 *  Lob
 *  private byte[] foo;
 * }
 * </pre>
 * Whatever txt2 ...
 * 
 * @author $Author: $
 */
public class Foo {

正确呈现:

Whatever txt1 ...

Lob
 private byte[] foo;

 Whatever txt2 ...
 Author:
 $Author: $

2 个答案:

答案 0 :(得分:1)

好的,我在其他地方找到了答案:https://stackoverflow.com/questions/2290757/how-can-you-escape-the-character-in-javadoc

事情是去{@literal @}

那么:

/**
 * Whatever txt1 ...
 * <pre>
 * {@code
 *  {@literal @}Lob
 *  private byte[] foo;
 * }
 * </pre>
 * Whatever txt2 ...
 * 
 * @author $Author: $
 */
public class Foo {

正确呈现为:

Whatever txt1 ...


{@Lob
private byte[] foo;
}

Whatever txt2 ...
Author:
$Author: $

答案 1 :(得分:1)

因为你引用了多行代码示例 - thread: 这个帖子中的以下答案有你的例子 - 逃避“@Override”上的“@”符号 https://stackoverflow.com/a/13512524

此致 克里斯托夫