Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
新东方携手故宫出版社推出2020年《故宫日历》(青少版)
-
-
显示|银保监会:一季度A类风险评级险企达102家4家险企不达标
-
-
-
『钛媒体APP』都2020年了,中国视频网站还有盈利的希望吗?
-
小机灵鬼|“自动驾驶”来了!安徽首条5G自动驾驶示范线路有望下半年开放
-
松鼠军评▲要中国反省自己,外交部强势回击你不够格,关键时刻印度突然发难
-
盗墓笔记 |《重启之极海听雷》朱一龙完美饰演吴邪,结局病好了吗?
-
衣在配不在贵|选择包包时都会避开3个误区,不然容易掉价,稍微讲究的中年女人
-
-
蔡少芬:我这辈子最正确的决定,就是在46岁高龄为小丈夫生儿子
-
-
界读丨铁娘子董明珠豪掷20亿助华为研造''芯片'' 要做世界第二
-
种情况|绿萝叶子打蔫、发软、不精神,一个小技巧,叶子又绿、又挺实
-
黄8红|85黄8红!中超头号恶汉刷新吃牌纪录,郑智列第二,另一恶汉第3
-
莱万多夫斯基|欧冠单赛季进球排行榜:前三名全被C罗占据!莱万要想破纪录决赛得戴帽
-
小诸葛聊车|奥迪车主不服软:车我不要了,乱停车被加轮胎锁
-
-