编码惯例

编码惯例是指开发人员在编码过程中应遵循的约定，或者说是初学者应努力养成的编码习惯。编码惯例不是强制性的，但对于软件开发工作的影响却非常大。

一、命名惯例

Java命名惯例，包括类、方法、接口、变量、常量和包。

命名规则：

1.类：名词或名词性词组，每个单词首字母大写，如class Person；class SprintRain。

2.方法：动词或动词性词组，首字母小写，第二个及以后单词首字母大写，如run()，displayInfo()。

3.接口：与“类”相同，如interface Runner。

4.变量：名词或名词性词组，首字母小写，第二个及以后开头的单词首字母大写；不提倡使用下划线“_”和美元符“$”作为变量开头；单词间可以使用下划线分隔；变量名不宜过长但应有意义，除非是临时使用（例如只涉及几行代码）后即丢弃的情况，不建议使用单个字母做变量名，常用的单字母变量名包括表示整数的i、j、k、m、n和表示字母的c以及表示异常对象的e等，如int i;、char c;、double salary; 、int age;、int student_age;、String studentName;、Exception e。

5.常量：名词或名词性词组，全部大写；单词间使用下划线分隔，如finlintMAX_LEVEL=10;

6.包：名词或名词性词组，全部小写；一般使用本公司组织网站域名的逆序、后跟具体的软件内部模块名，如package com.sun.java;、package com.mycompay.db:。

二、文件组织

建议一个源文件中只定义一个java类或接口，无论该类或接口是否被声明为public类型文件名都应该以类名进行命名。源文件中各成分的出现顺序依次为：开始的注释；package语句；import语句；类，接口的声明。

在一个java类中，各种成分的排列本无严格规定，也没有特别通用的惯例，但为了便于初学者掌握，这里也给出一个推荐的顺序：属性声明；构造方法声明；static语句；普通方法声明；main方法声明；内部类的声明。

三、分隔和缩进

1.使用空行

在下面情况下使用的空格行来分隔：在方法之间；在方法内部代码的逻辑段落小节之间；在方法中声明局部变量之后，具体的java语句之前；在注释行之前。

同一个源文件中，在定义的多个类，接口之间使用双行的空白行来分隔。

2.使用空格符

除了正常的成分之间（如数据类型和变量名之间）要以空格符分格外，还有两种情况使用空格符分隔，一种是运算符和运算数之间，如：c = a + b；，另一种在参数列表中逗号后面，如：void m1(int year, int month){}

3.使用换行符

即使语句很短小，也不建议在一行中写多条语句，是否代码的可读性会较差。例如：int = 5;int k = 6;k = k + 1;。一条语句的长度过长（如超过了80个字符）时应进行换行，虽然有的编辑器支持超长的编译功能，但频繁的水平滚动代码也会让人心慌意乱。换行只能在不同成分之间进行，凡是可以使用空格符之处均可使用换行符。

4.使用小符号

在比较复杂的表达式，即使按照优先级顺序能够满足运算要求，但为了增强程序的可读性，也应使用小括号明确规定其运算顺序。例如：if(a == b && c == d % 10)。但是，也不要在没有必要的情况下滥用小括号，例如：int k = (3) + 5;。

5.使用缩进

以下情况应使用缩进：类中的成分；方法体或语句块中的成分；换行时的非起始行。一般在一级成分的基础上在缩进4个空格，或跳到下一个制表位。

四、声明语句

建议每行声明一个变量，并尽量在声明的同时对其进行初始化，除非其初值尚不确定。局部变量应在其所在的方法或语句的开头集中声明。在此注意，应避免将变量不必要的声明在外层范围中，否则会影响代码的可读性。