编码规范很重要。 为什么重要我不在这里说。
以下内容根据个人情况有一些调整,在此提供参考。
1 .档案组织
程序行数不能太多。 注释和空行的分割必须合理。
2 .源文件
每个JAVA源文件都必须包含一个公共类或接口,并且公共类必须是这里的第一个类。
3 .开头评论
根据个人需要,最好列出类名、版本信息、日期等。
4 .软件包和导入语句
第一个注释以外的行是包语句,可以后跟导入语句。
5 .缩进
使用四个空格作为缩进单位,或将制表符占位符设置为4。
6 .排版
不要用另一个语句给多个变量赋值。
必须在参数列表中的逗号后加上空格。 (包括for语句)
二元运算符必须使用空格字符与操作数分离,“.”除外。
7 .行长
一行的长度不能超过150个字符。
8 .换行
每一行只有一个声明。
在两个方法之间使用空行。
如果表达式不能容纳在一行中,则为、
可以在{}中换行。
在逗号或操作员面前断开,
新行必须与兄弟公式对齐。
9 .评论
评论请不要写在大框里。 注释中不要包含制表符和后退等特殊字符。
注释有四种类型:
块、
单行、
尾端、
行尾。
在评论应该保持一致性的时候不要使用多种评论样式。
10.javadoc评论
要在类、接口、公用类变量和保护类变量中使用javadoc注释,必须包括说明、参数、返回值和异常说明。
11 .评论格式
方法内部采用单行注释,不要与代码在同一行。
12 .类中的成员变量
单行注释。
13 .声明
发表一个声明。
14 .初始化
尽可能由声明局部变量的同事初始化。
15 .布局
在代码块的开头声明变量,以最小化局部变量的范围。
16 .类和接口声明
方法名称及其参数列表前面的左括号之间不要有空格。
大括号在声明语句的末尾。
方法和方法之间用空行分隔。
17 .简单句
每一行最多包含一个语句。
18 .复合句
左大括号必须位于第一行的末尾,右大括号必须从另一行开始,并与复合语句的第一行对齐。
建议在单行if-else或for语句中也加大括号。 这可以有效防止在添加语句后忘记加大括号。
19 .返回语句
具有返回值的语句通常不使用括号,除非:
返回;
return myDisk.size (;
返回(大小? size :默认大小;
20 .方框文
if、else、while、for语句需要{}、空格。
{必须在一行的末尾,}在一行的开头。
21 .命名约定
包路径必须是小写的。
类名应该是名词,或者名词动词
将接口的第一个字符大写。
由多个单词合成的类名。 每个单词的首字母是大写的。
数据访问用表明刁方言方式。
界面的首字母是I。
方法采用驼峰命名法。
序列为byte[] buffer; byte buffer[]; 根除类名的首字母小写字母,在数组中添加Arr后缀。
给变量命名匈牙利。
常量都是大写的,使用关键字final。 用下划线分隔单词。
组件名称以相应的组件结尾。