Google 出品的 Java 编码规范和编程指南,权威又科学,强烈推荐(27)

Javadoc块的基本格式如下所示:

/** * Multiple lines of Javadoc text are written here * wrapped normally... */public int method(String p1) { ...

或者是以下单行形式:

/** An especially short bit of Javadoc. */

基本格式总是OK的 。 当整个Javadoc块能容纳于一行时(且没有Javadoc标记@XXX) , 可以使用单行形式 。

7.1.2 段落

空行(即 , 只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话) 。 除了第一个段落 , 每个段落第一个单词前都有标签<p> , 并且它和第一个单词间没有空格 。

7.1.3 Javadoc标记

标准的Javadoc标记按以下顺序出现:@param@return@throws@deprecated 前面这4种标记如果出现 , 描述都不能为空 。 当描述无法在一行中容纳 , 连续行需要至少再缩进4个空格 。

推荐阅读