Javadoc块的基本格式如下例所示:
/**
* 这里写了多行Javadoc文本,
* 像通常一样包裹起来...
*/
public int method(String p1) { ... }
或者如以下的单行示例所示:
/** 一段特别短的Javadoc文本。 */
基本格式始终是可以接受的。当整个Javadoc块(包括注释标记)可以放在一行时,可以使用单行格式。注意,这只适用于没有块标签(如 @return
)的情况。
在段落之间,以及在存在的块标签组之前,有一个空白行————也就是说,一个只包含对齐的前导星号( *
)的行。除了第一个段落,每个段落在第一个单词之前都有 <p>
,其后没有空格。其他块级元素的HTML标签,如 <ul>
或 <table>
,前面不加 <p>
。
使用的任何标准“块标签”都按照 @param
、 @return
、 @throws
、 @deprecated
的顺序出现,这四种类型的标签的描述永远不会为空。当一个块标签不能放在一行上时,续行缩进4个(或更多)空格从 @
的位置开始。