Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
-
-
大龙猫聊生活|那英便是八旗之一,14万满清后裔今在何方?其实就隐藏在我们身边
-
-
如果有2个儿子在中国会像大家所说的是2个“建设银行”吗
-
小城生活新媒体|带走自己产业回国发展!网友:为他点赞!,中国富豪放弃美籍
-
「筝弦上的赵姐」在家没事到处淘,家里就像进贼了似的,开心笑话:小侄子放寒假了
-
国际米兰|国米魔咒来袭!阿什拉夫遭合围压力山大 拜仁传奇遗留33年难题
-
-
-
「郑报融媒」警营好兄弟,工业路派出所有一帮战疫“老伙计”
-
央视新闻|反法西斯战争胜利研讨会举行:史料扩容,日军侵华再添铁证
-
纹身|认真学习!拉莫斯学纹身:身体也可以成为一块画布
-
明星八卦|又一个嫁入豪门的奥运冠军!如今39岁,婚后生活比郭晶晶更霸气
-
高人|近八成上市银行股价破净,年内40位董监高人均增持过百万元
-
贵州日报|数百人伤亡,场面极其混乱!黎巴嫩爆发大规模示威
-
路威|社交圈:泡椒铁林路威 和家人相聚后你看好谁爆发?
-
-