Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
『关闭总领馆』环球网评:关闭中国总领馆,美国再犯顶级战略错误
-
清单科技|信号稳了!,iPhone12全系列采用高通5G方案
-
舒莫财讯资讯号|农民不愿意种地,种粮只为“自给自足”?农业该如何“发展”?
-
刘亦菲带女儿看病!女儿跟她就像复制粘贴,没有出现的男一号是谁
-
「挖贝网」新签合同同比增长,中材国际2019年净利15.92亿增长16%
-
-
-
缅甸▲缅甸人的夜生活:属于“有钱人”的天堂,女人们的“地狱”
-
-
-
-
小熊回收站|从沙子到芯片,一图读懂自主研发芯片有多难
-
-
腾腾军师|以卖草鞋为生,为何皇室族谱没有漏掉他?,刘备出生乡下落魄皇族
-
老年人健康|人老后身上有股难闻的气味?医生直言:不能责怪,人之常情
-
-
-
-