Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
-
爆发|疫情后时代,郎酒扶持经销商逆势爆发,头部酒企的实力与担当彰显无余
-
万科猪倌产业链养成?全资收购环山,万科养猪这么认真想干啥?
-
李玟养的白眼狼,引发继承风波,继女公开表示将争夺财产
-
-
西阳|钟楚红年轻时有多美?艳压林青霞巩俐,成龙看她的眼神说明了答案
-
-
【中国新闻周刊】外媒:摩根大通将支付10亿美元和解价格操纵案调查
-
欧洲|新的“震中”已经出现,不是美国不是印度,死亡占全球三分之一
-
信者无敌|失去八级美颜后,吴昕真的是“姐姐”吗?,吴昕做客李佳琦直播间
-
『品如科技』致敬经典,哪些人会购买iPhone9?只有这群吃饱了没事做得
-
-
白雪阳春|合影靠边儿站显情商,穿娃娃裙好''心机'',章泽天与杨澜罕见同框
-
交易|中国股市:牢记经典“K线买卖口诀”,还在亏损的散户,值得学习
-
宇之轩|小姐姐穿一条浅色的牛仔裙,看着赏心悦目,街拍
-
-
脸上出现黄褐斑的原因有哪些 黄褐斑是怎么形成的是什么原因
-
『时尚蛙』96岁失恋,102岁获奖,哪有功夫去死,?日本传奇女性71岁再出发
-
消费商业观128G+麒麟990,华为旗舰大跳水,上市四个月降价八百,仅售2.4K