Java高手真经_编程基础卷——读书笔记（6）——Java代码规范

一、包的命名

完整的英文描述，由小写字母组成。包前有唯一前缀。例：

net.sourceforge

com.baidu.util

com.sun.eng

org.apache.ftp

二、类的命名

是一个名词，采用大小写混合方式，每个单词首字母大写，类和接口应遵循以下规则:

1、类的名字必须由大写字母开头，而单词中的其他字母均为小写

例：Test

2、如果类名由多个单词组成，则每个单词的首字母均应该为大写

例：TestFunction

3、如果类名中包含单词缩写，则缩写单词的每个字母都应该大写

例：XMLExample

类名尽量选择名词：interface storing{}

class Raster{}

class Util{}

三、变量的命名

变量的名字必须用一个小写的字母开头，后面的单词用大写字母开头。

例：int count;

string userName;

要求：

1、变量名尽量不要用下划线或美元符号$ 开头，尽管这在语法中是允许的。

2、变量名应简短且富于描述，应该易与记忆，即能够指出其用途。

3、尽量避免单个字符的变量名，除非是一次性的临时变量。

4、临时变量通常被取名为：i,j,k,n,m用于整型，c,d,e用于字符型。

四、常量的命名

类的常量是使用static final 来修饰的变量，但为了与普通变量区别，常量的名字用大写字母，并且指出该常量的完整含义，

如果其中包含多个单词，要以“_”连接

例:static final int MIN_WIDTH=4;

static final int MAX_WIDTH=6;

注意：在J***A代码中，无论什么时候，均提倡使用常量取代数字，固定字符串。也就是说，程序中除了0,1外，尽量不要出现其他数字。

常量可以集中在程序开始的部分定义，或者在更宽的作用域内定义，如静态类的静态变量。

五、数组命名

和变量的命名规则类似，但是应该总是如下的方式：

byte[] buffer

而不是

byte buffer[]

六、方法命名

使用有意义的标识符。Java中方法名以小写字母开头，名字都是用动宾结构的词组。开始动词字母小写，后跟一个首字母大写的名词，

中间单词首字母也要大写，例如：

public String getName();

public boolean isShowingInTree();

使用有意义的参数名，如果可能的话，使用有意义的参数名，如果可能的话，使用和要赋值的字段一样的名字，例如:

void SetSize(int size){

this.size = size;

}

属性的get和set方法的命名方法：

在get/set的后续首写字母，大写变量名。例：一个类中定义中有一个nama变量，那么定义的get/set方法的名为getName和setName，所有的

布尔型获取函数必须用单词is做前缀，例：

public boolean isString();

七、Java排版规范

1、空格

i、在表达式中，赋值（=）和其他双元运算符（||，&&，+，-，+=，-=，*，/等）与变量或常量之间，应该用一个空格隔开，（一个以上或没有）

都不正确。如：

a = c + d + b;

这个规定包括if for while 等语句。如：

if (a < b){

a = b + 1;

}

ii、在输入调用方法中的参数时，如果存在多个参数，用逗号隔开时，应紧接着用一个空格，如：

String a = (String)table.getValueAt(2, 0);

iii、左括号和后面的一个字符之间不应该有空格，如：

CallProc(param)；

iiii、语句中出现“(”和左边的关键字之间有一个空格的间隔，如：

while (...)

try (...)

2、空行

空行将逻辑相关的代码段分隔开，以提高可读性，请遵守以下规则。

i、如果一个文件中有几个类，类之间必须使用空行（建议用2个空行）。

ii、类的成员变量和类方法之间必须有空行（建议用2个空行）。

iii、在两个方法之间必须使用空行进行分隔（建议使用2个空行）。

iiii、对于与那些属于同一句块，但从逻辑上讲完成了不同功能的语句，应该用一个空行分开。

3、大括号{}中的“}”永远单独作为一行。

4、缩进

缩进排版通常以4个空格作为一个单位:

i、每个语句块向后缩进4个空格位置，例如：

public void setName(String name){

//下面的代码相对于方法头向后移4个空格

this.name = name;

}

ii、在语句很长的情况下，关于换行的缩进

每一行Java代码都应该限制在80个字符以内。当一行代码过长时，要考虑折行，折行后第2行的开头

应当与第一行的语句同等地位的词缩进对齐（使用“Tab”键无法对其时，不要减小缩进的空格数目，而是

错开，以“Tab”键缩进的空格为准）换多行时，第2行以后的各行一定要对齐。

以上是基本的java代码编写规范，其实，规范可以因地制宜，而不是拘泥于统一的标准。关于代码的规范，大同小异，但是如果理解了这些规范，写出

的代码，不仅可读性强，同时也提高的自身的代码素养。写出的代码也会显得美观，高大上。特别是在团队开发中，统一的代码规范的好处真实大大的。

作为，新学习java的初学者，及早地规范自己的编程风格，对以后的开发真是有百利而无一害的。