基于alibaba java 开发手册开发规约4:编程规约-注释规约

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_35165632/article/details/83549943

1.【强制】BC_ZS_01:类、类属性、类方法的注释必须使用 Javadoc 规范,使用 /**内容**/ 格式,不得使用 //xxx的方式。

2.【强制】BC_ZS_02:所有的抽象方法(包括接口中的方法)必须要用Javadoc注释,除了返回值、参数、异常说明外、还必须指出该方法做什么事情,实现什么功能。

3.【强制】BC_ZS_03:所有的类必须加创建者和创建日期。

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

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

猜你喜欢

转载自blog.csdn.net/qq_35165632/article/details/83549943