Java开发手册之注释规约「建议收藏」

Java开发手册之注释规约「建议收藏」Java开发手册之注释规约

大家好,又见面了,我是你们的朋友全栈君。

  1. 【强制】类、类属性、类方法的注释必须使用Javadoc规范,使用/**内容*/格式,不得使用
    // xxx方式。
    说明:在IDE编辑窗口中,Javadoc方式会提示相关注释,生成Javadoc可以正确输出相应注释;在IDE中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。
  2. 【强制】所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。
    说明:对子类的实现要求,或者调用注意事项,请一并说明。
  3. 【强制】所有的类都必须添加创建者和创建日期。
  4. 【强制】方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/* */注释,注意与代码对齐。
  5. 【强制】所有的枚举类型字段必须要有注释,说明每个数据项的用途。
  6. 【推荐】与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
    反例:“TCP连接超时”解释成“传输控制协议连接超时”,理解反而费脑筋。
  7. 【推荐】代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑等的修改。
    说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后,就失去了导航的意义。
  8. 【参考】谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。如果无用,则删除。
    说明:代码被注释掉有两种可能性:
    1)后续会恢复此段代码逻辑。
    2)永久不用。
    前者如果没有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。
  9. 【参考】对于注释的要求:
    第一、能够准确反应设计思想和代码逻辑;
    第二、能够描述业务含义,使别的程序员能够迅速了解到代码背后的信息。
    完全没有注释的大段代码对于阅读者形同天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路;注释也是给继任者看的,使其能够快速接替自己的工作。
  10. 【参考】好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担。
    反例:
  // put elephant into fridge  put(elephant, fridge);    

方法名put,加上两个有意义的变量名elephant和fridge,已经说明了这是在干什么,语义清晰的代码不需要额外的注释。
11. 【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描,经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1) 待办事宜(TODO):( 标记人,标记时间,[预计处理时间])
表示需要实现,但目前还未实现的功能。这实际上是一个Javadoc的标签,目前的Javadoc 还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个Javadoc标签)。
2) 错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间])
在注释中用FIXME标记某代码是错误的,而且不能工作,需要及时纠正的情况。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/106531.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • 代码审计系列:久草CMS(9CCMS)V1.9

    代码审计系列:久草CMS(9CCMS)V1.9偶然看到一篇9CCMS(久草CMS)V1.9弱口令+后台拿shell的文章,兴起去找来源码进行审计

    2022年10月19日
  • 一维卷积神经网络处理序列模型

    一维卷积神经网络处理序列模型fromkeras.datasetsimportimdbfromkeras.modelsimportSequentialfromkeras.layersimportEmbedding,Conv1D,MaxPooling1D,GlobalMaxPooling1D,Densefromkeras.optimizersimportRMSpropmax_featu…

  • java分页计算当前页_java分页计算[通俗易懂]

    java分页计算当前页_java分页计算[通俗易懂]java仿google的分页算法1.现将数据从数据库读取出来封装一个java类中,在java类中计算publicclassPage{//成员变量//当前页privateintnowpage;//总记录数privateintcountrecord;//总页数privateintcountpage;//当前页记录开始的位置privateintpageindex;//每页显示的…

  • CurrentHashMap笔记

    CurrentHashMap笔记其key不为空桶上链表长度达到8个或者以上,并且数组长度为64以下时只会触发扩容而不会将链表转为红黑树CurrentHashMap(jdk1.8)之所以线程安全因为在添加元素时候,采用synchronized来保证线程安全,然后计算size的时候采用CAS操作进行计算,采用volatile修饰HashEntry[]table保存数据(Node数组),采用table数组元素作为锁细化锁粒度CurrentHashMap(jdk1.7)(Entry数组)之所以线程安全因为

  • java switch用法_Java switch语句

    java switch用法_Java switch语句Javaswitch语句用于从多个条件执行一个语句。它就像if-else-if语句一样。语法:switch(expression){casevalue1://codetobeexecuted;break;//optionalcasevalue2://codetobeexecuted;break;//optional……default://codetobee…

  • RIP路由

    RIP路由

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号