Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
中央扫黑除恶督导组反馈情况当日,杨浦区政法委书记被查
-
-
法治日报|《南京市文明行为促进条例》施行 重点治理不文明行为
-
『中金网』许多投资者都在购买垃圾债券!避险策略魅力不再?,“饥不择食”?为了寻求回报
-
-
-
-
「吾家妻宝」5本古言宠文,抹茶曲奇《吾家妻宝》超甜,从头甜到尾!
-
-
-
简宅范|陈道明晒上亿豪宅,足不出户就能打高尔夫,装修堪比穿越剧
-
小畜播报|被导演相中一事,这句话暴露高情商!,谢娜爆《九妹》九妹MV
-
-
搞笑小恶魔|是不是玩不起,咱用钓的?,搞笑GIF趣图:我靠
-
PChome电脑之家|免息分期补贴超1200元,苹果四款新品全线上架
-
馆阁|有人称启功书法有“馆阁体”遗风,不能称为大师?你怎么看
-
「摩托罗拉」摩托罗拉亮5G王牌:90Hz瀑布屏+1.08亿像素+骁龙865,价格感人
-
同色|街拍:长款毛衣搭配袜靴, 同色搭配更显高级气质
-