Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
上单|LOL:FLY上单solo成孤儿,DRX全力养多兰一次不死并且超神!
-
#济南#紧急通知:雷雨、冰雹、10级风!济南发布强对流重要天气预报
-
-
#佛山在线#首批检测教职工约450人,高明开展教职工核酸检测
-
北斗导航:为何美军不对北斗设防?俄罗斯专家提出疑问,道出全世界的疑惑!
-
青年|王者荣耀:本赛季胜率最高英雄,吉吉国王上榜,榜首被辅助霸占
-
都市民生汇@医生不许遭其丈夫暴打、揪头发,暴力伤医来了!孕妇晚上想回家住
-
「迈克·泰森」只要3000万便可与泰森一战,一龙却撤回挑战,被训练视频吓到了?
-
-
-
-
『萌宠动物集视频』此植株茎干长满“肉瘤”,外形丑,但人称“广东人参”,是味草药
-
-
孙坚仿佛是个圆规,快乐大本营过竿儿游戏里,他原地画圈
-
奇瑞瑞虎|上市被奇瑞吹上天,号称H6终结者,如今月销仅4000台,沦为笑柄
-
华为|与世界上最富有的国家签订10年5G协议,华为又拿一大订单,厉害了
-
广西被严重高估的城市知名度远超省会!CDP增速却全省倒数第一
-
灵璧县广播电视台|灵璧跻身国家级县城新型城镇化建设示范名单
-
富豪|原创43岁海清近照似少女,还撞脸刘诗诗,嫁富豪老公儿子已14岁?