Java程序编码规范.docx

《Java程序编码规范.docx》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、Java程序编码规范开发程序时，往往会有很多人参与，为了使程序的结构与代码风格标准化，以便于使每个参与开发的人员尽可能直观地查看和理解其它人编写的代码，需要在编码之前制定一套统一的编码规范。下面介绍一套Java语言中常用的程序编码规范供读者参考。命名规则数据类型简写规则程序中定义常量、变量或方法等内容时，常常需要指定类型。下面介绍一种常见的数据类型简写规则，如表1所示。表1数据类型简写规则数据类型简写整型int字符串str布尔型bl短整型sint长整型lint单精度浮点型flt双精度浮点型dbl字节型bt变量及常量名称命名规则根

2、据不同的程序需要，编写代码时需要定义一定的变量或常量。下面介绍一种常见的变量及常量的命名规则。变量：java中变量由单个或者多个单词组成，其中单个单词或多个单词的第一个单词所有字母小写，其余单词首字母大写，并且不能使用java中的关键字。例如：userName。变量的名称要有意义，能从变量名称中理解其含义。常量：常量是在程序运行过程中值不能改变的量。常量也要使用有意义的名称，并且单词的所有字母要大写，如果由多个单词组成，就使用下划线分割。例如USER_NAME。类命名规则使用完整的单词，避免使用缩写。类名称的首字母要大写。尽量使

3、用名称。类通常表示一种对象类型，而对象一般使用具有名词性质的名称。不要使用$或者下划线作为前缀。尽管在VisualBasic和VisualC++等其它语言中，这是非常普遍的，但在java中不提倡使用。自定义异常类命名通常要以Exception结尾，但应该尽量避免自定义异常类。避免将多个类放在一个文件里。初始化类的实例时，除非非常必要，否则不要赋值为null。成员变量命名规则成员变量名称通常都是名词，命名规则与变量相同。例如name和age等。成员变量名称不能与java关键字相同。尽量不要提供public和protected的成员

4、变量，使用设置器和访问器操作它们。方法命名规则方法名通常都是动词，因为方法用来实现一个对象的行为功能，例如read（）、write（）、start（）和stop（）等。当重载方法是，参数的顺序和声明时的参数顺序要一致。定义方法名时不要使用缩写。如果认为应用程序中的某些项目使用缩写，那么请将这些情况加上注释，并确保每个人在所有的时间内都使用这些缩写，一定不要在某些方法中对某些单词进行缩写，而在别的地方却不使用缩写。一个方法的代码长度最好不要超过25行。避免方法中超过5个参数的情况，如果超过了，则应使用自定义类（即JavaBean）

5、来传递多个参数。接口命名规则接口名称的首字母要大写。接口名称尽量具有描述性，并使用形容词，因为接口常常用于给一个类添加某种能力，例如Runnable。避免一个接口中只有一个成员，尽量使每个接口中包含3~5个成员。接口中的成员不应该超过20个。尽量少使用匿名接口实现。代码版式统一代码缩进每个项目都应该根据实际情况建立统一的代码缩进标准，例如统一缩进一个Tab制表符，这样代码看起来非常美观，而且层次感很清楚，方便阅读代码。合理使用空行在不同的功能的代码段之间使用空行分割。在每个类声明之后、每个方法声明之后都要加空行。在一个方法体内，

6、逻辑上密切相关的语句之间不加空行，其它地方应该加空行分割。代码换行一行代码只做一件事情，如定义一个变量，或只编写一条语句。if、switch、for、foreach格式的循环、while等语句独占一行，执行语句不能紧跟其后，而且不论执行语句有多少都应该加{}。代码行最大长度应该控制在70~80个字符以内，代码不要过长，否则不便于查看。长表达式要在低优先级运算符处拆分成新行，运算符放在新行之首（以便突出运算符）。拆分的新行要适当缩进，以便使排版整齐。空格的使用关键字后面应该加空格，否则无法解析关键字。if、for、while等控制

7、语句关键字后面应该加空格，然后再跟左大括号，以便突出关键字。方法名后面不要加空格，而应紧跟左小括号，以便与关键字区分。赋值运算符、比较运算符、算术运算符、逻辑运算符和位运算符等二元运算符的前后应该加空格。一元运算符如“！”，“++”，“—”，“&”等前后不加空格。类似“[]”，“.”这类符号的后面不加空格。对于表达式比较长的if语句和for语句，为了看上去更加紧凑，可以适当去掉一些空格。代码注释注释的目的文字说明代码的作用（即为什么要用编写该代码，而不是如何编写）。指出该代码的编写思路和逻辑思路。代码中的重要转折点。使代码的阅读

8、者不必在他们的头脑中仿真运行代码的执行过程。代码注释规范方法体内使用类似“//”的形式进行注释，前面需要使用空格进行对齐时，使用Tab键代替空格键。对类进行JavaDoc注释，说明类的含义和作用以及作者等信息。对方法进行JavaDoc注释，说明方法的作用和使用的