【软件开发规范篇】JAVA后端开发编码注释规范

作者介绍：本人笔名姑苏老陈，从事JAVA开发工作十多年了，带过大学刚毕业的实习生，也带过技术团队。最近有个朋友的表弟，马上要大学毕业了，想从事JAVA开发工作，但不知道从何处入手。于是，产生了写一个博客专栏想法，介绍当前互联网企业JAVA项目开发如何快速入门。

本文收录于《30天企业JAVA项目开发实战入门》专栏，该专栏内容以当前互联网软件企业中的项目实战为线索，介绍企业JAVA项目开发中涉及到的开发流程、技术、工具、规范要求等等。帮助想从事JAVA开发的大学生或新人，更快的、更好的入门JAVA后端开发工作。

一、前言

现在的软件项目都是团队多人合作一起开发，软件架构的复杂性也需要协同开发完成，如何高效地协同呢？

无规矩不成方圆，无规范难以协同。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。

在软件项目开发过程中，我们在编写代码的时候，都会被要求在代码添加一些注释说明，描述代码的功能等等。从而，增加代码的可读性，方便后续的代码维护工作。那么，关于在代码中添加注释，有没有相关的规范要求呢？

所以，本文介绍一下给JAVA代码添加注释，可以遵循的一些工作规范。

二、关于代码注释的规范

1. 【参考】代码中添加注释的一些要求。

   第一、能够准确反映设计思想和代码逻辑；
   ​第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注 释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作；
   ​第三、注释力求精简准确、表达到位。避免出现注释的一个极端，即过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

2. 【强制】类、类属性、类方法都必须有注释，且必须使用 Javadoc 规范，使用/*内容/格式，不得使用// xxx 方式。

   说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

3. 【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释，使用/*内容/格式，除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

6. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

   反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

7. 【强制】所有的类都必须添加创建者、创建日期和描述；

   说明：可以设置文件模板，但在设置模板时，注意 IDEA 的@author 为${USER}，而 eclipse 的@author 为${user}，大小写有区别。另外，日期的设置统一为 yyyy/MM/dd 的格式。

模版如下：

 /**
@author ${USER}
@date ${YEAR}/${MONTH}/${DAY}
*/

正例如下：

在IDEA中设置模版方法如下所示：

8. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。

   说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

9. 【参考】谨慎注释掉代码。在代码上方进行详细说明，而不是简单地注释掉。如果代码无用，则直接删除。

   说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉即可，假如需要查阅历史代码，登录代码仓库即可。

   10.【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

   第一、 待办事宜（TODO）:（标记人，标记时间，[预计处理时间]）
   表示需要实现，但目前还未实现的功能。

   第二、 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
   在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

三、总结

以上介绍了软件项目开发中，编码代码时添加代码注释，可以遵循的一些规范。

附本文参考资料：

• 阿里云官方知乎：https://www.zhihu.com/org/a-li-yun-97-77
• 阿里云开发者官方社区：https://developer.aliyun.com/
• 阿里开发者官方CSDN社区：https://blog.csdn.net/alitech2017?type=blog
• 阿里云云栖号CSDN：https://blog.csdn.net/yunqiinsight/category_10231626.html
• 阿里巴巴技术团队发布的《JAVA开发手册》泰山版
• 阿里云开发者官方微信公众号

如果您对文章中内容有疑问，欢迎在评论区进行留言，我会尽量抽时间给您回复。如果文章对您有帮助，欢迎点赞、收藏。您的点赞，是对我最大的支持和鼓励，谢谢 :-）