Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
『电工』在农村干电工,一月能赚多少钱?答案揭晓!网友:远比打工强!
-
快科技|发了1200万美元还要回!FCA要求工人返还停工期多支付的工资
-
「温暖对白」好领导和做好本职工作,哪个最重要?,在日常工作中
-
「2000个扶贫项目」新疆加大非贫困县扶贫投入 逾2000个扶贫项目巩固脱贫成果
-
【吉利服】俄专家敢于直言戳破牛皮,美叫嚣在中国家门口动手他们也不畏惧
-
天涯明月刀手游|天涯明月刀手游:你所不知道的琅纹小技巧,想要提升战斗力不是问题!
-
-
怪咖搞笑实在是不想逛了 于是我想出了一个妙法,幽默笑话:昨天陪女友逛街
-
-
【】绿军和少帅史蒂文斯续约 后者带队胜场排队史第4
-
-
-
数码东东:还在等?宁可停产也不降价!等等党只能泪流
-
发布会|证监会批准国际铜交易 交易时间为2020年11月19日
-
「美国」实在太惨烈了!5月4日15时,绝望的消息再从美国传来
-
-
王者荣耀|28号限定返场,获取条件公布,部分玩家无法购买
-
李若彤|李若彤:情断富商之后单身至今,56岁无儿无女,结婚全靠缘分
-
『旅客列车』返程高峰来了!广铁广东地区今到旅客56万人
-