江苏龙网

  1. 主页 > 生活百科 > >

Google 出品的 Java 编码规范，强烈推荐( 六 )

Java


Tip：如果有一些相关信息是需要读者了解的，那么以上的例外不应作为忽视这些信息的理由 。例如，对于方法名 getCanonicalName， 就不应该忽视文档说明，因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外：重写
如果一个方法重写了超类中的方法，那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法，如有需要，也是要使用Javadoc的 。如果一个注释是用来定义一个类，方法，字段的整体目的或行为， 那么这个注释应该写成Javadoc，这样更统一更友好 。




推荐阅读


上一篇：关于福建武夷山正山小种的介绍

下一篇：茶文化的论文鉴赏