在学习和结对编程的过程中,大家编码的习惯不一定相同,导致交流上受到较大影响,于是学习整理了Java编写代码中的一些规范。
不用Tab键,应用四个空格。不同编辑器Tab会可能显示不同宽度。
80个字符。
超长的语句应该在一个逗号或者一个操作符后折行。一条语句折行后, 应该比原来的语句再缩进4个字符。
使用UTF-8编码。
相对独立的代码块之间应用空行隔开。
为是使代码更加清晰,在对两个及以上成员进行一般运算符(+、-、*、/、%等)的对等操作时,在操作符前后加一个空格;但对于其他关系紧密的操作符,如“->”、小括号等。
逗号后不换行,紧跟一个空格。
对于{},大括号的开始在代码块开始的行尾,闭合在和代码块开头平行同一缩进的行首。
每个if、while、for都不要省略括号。
如:
for (int i = 0; i < 10; i++) { System.out.println(arg); }
只有小写字母,用‘.’连接。
通常可用所在单位的Internet域名的倒序,最后一个标识符说明该包的功能。
如:
package cn.***.***.organization
Pascal:首字母大写,不同单词首字母大写作为分隔。
如: SupplierService
变量、方法:
Camel:首字母小写,不同单词首字母大写作为分隔。
如:addNewContract,size
static final常量:
全字母大写,不同单词用‘_’分隔。
如:MAX_INDEX
动宾结构,一般不同前缀表示不同含义。
如getName()、setName()、addOrder()、removeOrder()等
文件名同类命名,成员同常量命名。
变量声明应该尽量和变量使用放在一起,不能隔开太远。
尽量减少变量作用域。
能用局部变量的,不要使用实例变量;能用实例变量的,不要使用静态变量。变量的生存期越短,意味着它被误用的机会越小,同一时刻要关注的变量的状态也越少。实例变量和静态变量默认都不是线程安全的,局部变量是线程安全的。
/** */
用来注释类、接口、方法、变量、常量
/** * @description 测试类 * @ClassName HelloWorld.java * @author 。。。 * @Date 2021-9-25 00:00:00 * @version 1.00 */
/** 字符串信息 */ private String strMsg = null;
/** * 类方法的详细使用说明 * @param 参数1 参数1的使用说明 * @param 参数2 参数1的使用说明 * @return 返回结果的说明 * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明 */
/** * 构造方法的详细使用说明 * @param 参数1 参数1的使用说明 * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明 */
/* */
用来注释文件头、算法实现、复杂代码块、修改记录
//
一般注释局部变量