7.1.1 一般形式

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

  1. /**
  2.  * Multiple lines of Javadoc text are written here,
  3.  * wrapped normally...
  4.  */
  5. public int method(String p1) { ... }

或者是以下单行形式：

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

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