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

2019-05-16

单元测试类中的测试方法可能是不言自明的最常见例子了，我们通常可以从这些方法的描述性命名中知道它是干什么的，因此不需要额外的文档说明。

Tip：如果有一些相关信息是需要读者了解的，那么以上的例外不应作为忽视这些信息的理由。例如，对于方法名getCanonicalName ，就不应该忽视文档说明，因为读者很可能不知道词语canonical name指的是什么。

7.3.2 例外：重写

如果一个方法重写了超类中的方法，那么Javadoc并非必需的。

7.3.3 可选的Javadoc

对于包外不可见的类和方法，如有需要，也是要使用Javadoc的。如果一个注释是用来定义一个类，方法，字段的整体目的或行为，那么这个注释应该写成Javadoc ，这样更统一更友好。

看完本文有收获？请转发分享给更多人

推荐阅读

上一篇：iOS 12.4首个测试版：或将新增这一项重大更新，银行可能要慌了！

下一篇：锤子不死，老罗实锤还有新机发布，因为有大把时间和胶原蛋白