我的Java编码规范

时间:2021-11-01 20:20:42

1、类名采用驼峰命名法,首字母大写。

2、类变量采用驼峰命名法,首字母小写。

3、方法名是一个动词短语,首字母小写,尽量能描述清楚这个方法的意图。

4、注释在精不在多,一个好的注释要尽量描述出这段代码的所要表达的意思。

5、一个函数中将进行不同操作的代码段分空行隔开,方便之后进行维护。

6、变量名尽量能够用表达改变量意图的名称去命名,除了循环变量可以简化成i,j之外,其他变量不要用单个字母进行命名。

7、一个函数只做一件事

8、常量采用大写字母加下划线进行命名

9、注释掉的代码尽量进行删除

10、坚决避免代码的重复,重复的代码应看如何能够进行重构。

11、SQL关键字全部使用大写字母。