Javadoc的使用位置

(1)Javadoc的使用位置

至少每一个 public 类以及这样的类中的每一个 publicprotected 的成员都有Javadoc,除了下文中提到的一些例外。

(2)例外:重写

当一个方法重写超类型的方法时,不必总是在该方法上附带Javadoc。

例外:不言自明的成员

对于简单且一目了然的成员,如 getFoo() ,在确实没有其他值得一提的内容的情况下,Javadoc是可选的,只需说明”Returns the foo”即可。

Tip

重要: 如果某些典型的读者需要知道的相关信息被省略了,那么不适合用这个例外来为省略文档的错误做法辩护。例如,对于一个名为 getCanonicalName 的方法,如果读者很可能不知道”canonical name”是什么意思,那么不要省略其文档(以这里只需要说明 /** Returns the canonical name. */ 为借口,但实际这里的成员名并非一目了然)!

(3)非必需的Javadoc

其他类和成员可根据需要或作者意愿添加Javadoc。

每当需要使用实现注释来定义类或成员的总体目的或行为时,该注释应以Javadoc的形式编写(使用 /** )。