Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
-
还原历史背后真相@为何迫不及待要“解封”呢?,美国疫情如此严重
-
-
健身学堂|触目惊心,突然停止健身会怎样?小心这些变化
-
周星驰|星爷新作《美人鱼2》正式杀青,星爷达叔再次联手,观众强烈期待!
-
大陆赛马网|安徽省马术运动协会将承办2020年全国马术耐力锦标赛
-
招聘|花一样的工资招聘新员工,没过一会厂长后悔了,原因很现实!
-
军人的肩章辽宁舰搭载36架舰载机太少,国产航母是如何达到48架的?,6万吨
-
小鱼干游戏|“吃鸡”又出现1招炸队友不受惩罚,xxs乐坏了,请别手误打载具
-
「科技小畅聊」被看上就跑不掉了,可有你?,“爱情中最有手段”的四大星座
-
回锅肉|不是今年《中国新说唱》强,而是“回锅肉”太多,整个水平被抬高
-
-
-
瘦肚子@吃什么能“瘦肚子、减小腹”最快?你最关心的答案来了
-
三十岁,对未来无所适从,谁能给点经历或者建议。鸡汤不需要?
-
-
「猪脚大妈」美国向全球招募医护人员你会心动吗?,日工资超出了6000元人民币
-
-
淘宝人生|你如何看待此事,淘宝人生游戏国庆期间为明星庆生