【Java开发手册之编程规约(八)】注释规约
来源:互联网 发布:神魔诛天战宠进阶数据 编辑:程序博客网 时间:2024/05/21 13:23
【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用// xxx 方式。
说明:在 IDE 编辑窗口中, Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注
释 ; 在 IDE 中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高
阅读效率。【强制】所有的抽象方法 ( 包括接口中的方法 ) 必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。
说明:对子类的实现要求,或者调用注意事项,请一并说明。【强制】所有的类都必须添加创建者信息。
【强制】方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/* */注释,注意与代码对齐。
【强制】所有的枚举类型字段必须要有注释,说明每个数据项的用途。
【推荐】与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
反例:“ TCP 连接超时”解释成“传输控制协议连接超时”,理解反而费脑筋。【推荐】代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑等的修改。
说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后,
就失去了导航的意义。【参考】注释掉的代码尽量要配合说明,而不是简单的注释掉。
说明:代码被注释掉有两种可能性:1 ) 后续会恢复此段代码逻辑。2 ) 永久不用。前者如果没
有备注信息,难以知晓注释动机。后者建议直接删掉 ( 代码仓库保存了历史代码 ) 。【参考】对于注释的要求:第一、能够准确反应设计思想和代码逻辑 ; 第二、能够描述业务含义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路 ; 注释也是给继任者看的,使其能够快速接替自己的工作。
【参考】好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担。
反例:
// put elephant into fridge
put(elephant, fridge);
方法名 put ,加上两个有意义的变量名 elephant 和 fridge ,已经说明了这是在干什么,语
义清晰的代码不需要额外的注释。【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描,经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1 ) 待办事宜 (TODO) : ( 标记人,标记时间, [ 预计处理时间 ])
表示需要实现,但目前还未实现的功能。这实际上是一个 Javadoc 的标签,目前的 Javadoc
还没有实现,但已经被广泛使用。只能应用于类,接口和方法 ( 因为它是一个 Javadoc 标签 ) 。
2 ) 错误,不能工作 (FIXME) : ( 标记人,标记时间, [ 预计处理时间 ])
在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况。
- 【Java开发手册之编程规约(八)】注释规约
- 【Java开发手册之编程规约(一)】命名规约
- 【Java开发手册之编程规约(三)】格式规约
- 【Java开发手册之编程规约(四)】OOP规约
- 阿里巴巴Java开发手册- 编程规约-注释规约
- 阿里Java开发手册之编程规约
- 阿里Java开发手册之编程规约
- Java 开发手册之编程规约
- 阿里Java开发手册之编程规约
- 【Java开发手册之MySql规约(二)】索引规约
- 【Java开发手册之MySql规约(三)】SQL规约
- 【Java开发手册之MySql规约(四)】ORM规约
- 【Java开发手册之工程规约(二)】二方库规约
- 【Java开发手册之工程规约(三)】服务器规约
- Java开发代码规范之编程规约(六)——注释规约
- 【Java开发手册之编程规约(二)】常量定义
- 【Java开发手册之编程规约(五)】集合处理
- 【Java开发手册之编程规约(六)】并发处理
- 关于ArcObjects图层编辑的读写编辑锁
- nginx+tomcat集群负载均衡
- web.xml加载自定义配置文件(.xml)
- FJHttp.request获取网络数据示例
- git 问题总结
- 【Java开发手册之编程规约(八)】注释规约
- $http传输数据量较大
- JS远程监测-Linux平台设置
- getchar
- Python+Opencv识别两张相似图片
- FragmentPagerAdapter强制刷新
- 通过字段对List<HashMap<String,Object>>进行分类
- 用gulp压缩js和css
- Linux Kernel 学习笔记2:模块参数