Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
-
「肺癌」痰湿是怎样形成的?痰湿的形成与脾密切相关!
-
金马奖|加速堕落!台湾金马奖沦为自嗨闹剧:劣迹艺人和吸毒艺人同入选
-
新机发布官宣!华为10月22日召开全球发布会 华为Mate40系列终出场
-
华为郭平:5“机”协同,助力深圳成为全球数字经济样板城市
-
#心理学#心理学:选你个你最喜欢的自行车,测你最爱的运动是什么
-
伊朗_社会|第N起“蹊跷”大火找上伊朗,伊朗官员:有关部门已高度警觉
-
第一财经|外围股市大跌 A股能否走出独立行情?丨市场辩论会
-
2022年除夕夜寺院恢复开放吗,2022年除夕寺庙会不会关闭
-
为什么有人宁愿溢价买华为,也不考虑性价比高还有现货的小米?
-
[龙争虎斗]寂然想冲全国前十,打开巅峰赛榜单却“笑抽”:榜一榜二这是在龙争虎斗?
-
显瘦|万能的黑裤子,搭什么都时髦显瘦么?你得上宽下窄这样穿
-
绣球花的养殖方法和注意事项冬季 绣球花的养殖方法和注意事项冬季养护
-
快科技@腾讯首次晒内部机密数据:使用最多语言C++、研发人员占比高达66%
-
-
lfsoccer足球|现身为体操运动员助威!退役之后成教练,“东方美人”庞盼盼
-
-
-
|张颖颖用特别方法瘦身,汪小菲事业心满满,双方做出正确选择