Tip:如果有一些相关信息是需要读者了解的,那么以上的例外不应作为忽视这些信息的理由 。例如,对于方法名 getCanonicalName, 就不应该忽视文档说明,因为读者很可能不知道词语 canonical name指的是什么 。
7.3.2 例外:重写
如果一个方法重写了超类中的方法,那么Javadoc并非必需的 。
7.3.3 可选的Javadoc
对于包外不可见的类和方法,如有需要,也是要使用Javadoc的 。如果一个注释是用来定义一个类,方法,字段的整体目的或行为, 那么这个注释应该写成Javadoc,这样更统一更友好 。
推荐阅读
-
-
-
吃货|吃腻了糖炒栗子的你,可以试试栗子的这些花式吃法
-
-
相对论@比光速快10亿倍的“速子”是如何不与相对论矛盾的?
-
-
-
高校|清北人师,北航北理,各省录取线居高不下,哪些热门专业最抢手
-
周到|梅西既当爹又当妈,打破运动战进球荒,球王却高兴不起来
-
-
海军|美军嗅到危险信号?双航母突然中断休整,搭载数百架战机奔赴西太
-
兔子IP转换器|QQ自由幻想手游多开防封号搬砖赚钱攻略
-
中国教育后勤协会|2020年全国教育后勤社团组织秘书长工作会议在珠海召开
-
【洋哥爱生活】繁花似锦,佳期如梦,3星座拥抱旧爱,爱火重燃,7天后
-
小仓鼠打洞学会另一种情怀|他是如何成就千秋大业的?,始皇嬴政的身世之谜
-
|参加两次节目失利,曾表示输了就去做老师,学习舞蹈十年
-
欧美明星|冷门又好看的6部动作片,你可能一部都没看过
-
【高校】大学里很“冷门”的6个专业,需求量却很大,学生就业率很高
-
新机发布Oppo首款智能电视即将发布,三款型号,最高售价65寸8000+元
-
百色|6500万年前形成的神秘天坑,坑底发现巨蟒爬痕,推算大小让人咂舌