Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
-
-
游侠恨风:你遇到过哪些“被职业选手带货”的队友,「讨论」
-
衣在配不在贵|混搭风低调又时髦,“百亿阔太”文咏珊气质出众!穿骑行裤秀长腿
-
-
我娱你乐乐五官闹着玩似的!,鞠婧祎再遇“最强卸妆水”?遭摄像机怼脸拍
-
烹饪|干炸黄花鱼怎么做好吃?大厨教我小技巧,外酥里嫩,凉了也不软!
-
-
文汇网|算什么男人?一微信昵称“好男人”的男子违法售卖象牙制品被依法刑拘
-
海亮股份|海亮股份等股获融资客买入占成交额比超三成
-
-
-
-
鑫意佳涂装营运平台|室内房间刷涂料颜色怎么搭配比较好呢?
-
历史的长河故事如果能遇到他,最好离得远远的,三国中很多人喜欢曹操
-
猫眼观史|还必须用美国飞机送烈士回国,金一南少将:这是耻辱,大使馆被炸
-
历史大解密|经过考证,这里在秦朝发生过一件大事,陕西临潼鬼沟出土无头石人
-
-