Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
-
|真的有人“长生不老”?活了443岁,晚年体重5公斤,世人敬重
-
ZAKER|热点|联合国呼吁减免低收入国债务应对新冠危机
-
新华网|约旦家族企业:进博会是零距离接触中国市场的宝贵契机
-
-
『苟颜玩科技』手机发展速度这么快,我心目中的顶级旗舰手机到底什么样?
-
健身励志训练营|越痛,越不动声色。越苦,越保持沉默,早安,长大后却学会
-
极限挑战嘉宾摘国家二级保护植物|极限挑战嘉宾刘宇宁摘国家二级保护植物 事后道歉:是摆放好的道具
-
娱乐当家|如何做到基金赚钱, 持有人也赚钱,微信红包|一个头部基金经理的思索:
-
-
SUV|只要5.48万元,这台年轻人都买得起的SUV正式上市
-
-
-
-
长沙一对高位截瘫夫妇举行“轮椅上的婚礼”,30多位“轮友”到场祝贺
-
-
-
「奥林匹克公园」是一个啥景点,有啥吸引人的地方和游览建议
-
苏七墨|胡可穿搭有一套,薄牛仔褶皱裙配半马尾太减龄,直接素颜也太美了