7.3.1 例外:不言自明的方法对于简单明显的方法如getFoo,Javadoc是可选的(即,是可以不写的)。这种情况下除了写“Returns the foo”,确实也没有什么值得写了。单元测试类中的测试方法可能是不言自明的最常见例子了,我们通常可以从这些方法的描述性命名中知道它是干什么的,因此不需要额外的文档说明。
7.1.1 一般形式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),可以使用单行形式。