2024年6月15日发(作者：)

阿里巴巴Java网页版开发手册

大家不论是参加Java培训还是学习别的开发语言，其最终的目的多数都是想要找到一

份高薪的好工作就业，那么阿里巴巴企业应该是不少人心目中的理想企业了，相信也有不

少的小伙伴很想进去阿里巴巴去工作，本篇文章小编就和大家来分享一下阿里巴巴Java网

页版开发手册-注释规约，希望对小伙伴们有所帮助。

1、【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，

不得使用// xxx 方式。

说明：在IDE 编辑窗口中， Javadoc方式会提示相关注释，生成Javadoc可以正确

输出相应注释; 在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回

值的意义，提高阅读效率。

2、【强制】所有的类都必须添加创建者和创建日期。

3、【强制】所有的抽象方法 ( 包括接口中的方法 ) 必须要用Javadoc注释、除了返

回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：对子类的实现要求，或者调用注意事项，请一并说明。

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

5、【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与

关键字保持英文原文即可。

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

6、【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部

多行注释使用/* */注释，注意与代码对齐。

7、【参考】合理处理注释掉的代码。在上方详细说明，而不是简单的注释掉。如果无

用，则删除。

说明：代码被注释掉有两种可能性：1 ) 后续会恢复此段代码逻辑。2 ) 永久不用。前

者如果没有备注信息，难以知晓注释动机。后者建议直接删掉 ( 代码仓库保存了历史代

码 )

8、【参考】对于注释的要求：第一、能够准确反应设计思想和代码逻辑;第二、能够

描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码

对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路;注

释也是给继任者看的，使其能够快速接替自己的工作。

9、【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、

核心逻辑等的修改。

说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件

严重滞后，就失去了导航的意义。

10、【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免

出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。