编码规范Word文档下载推荐.docx
《编码规范Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《编码规范Word文档下载推荐.docx（15页珍藏版）》请在冰点文库上搜索。
在多数Java源文件中，第一个非注释行是包语句，在它之后可以跟引入语句。
例如：
packagejava.awt;
importjava.awt.peer.CanvasPeer;
2.1.3类和接口说明（ClassandInterfaceDelarations）
下表描述了类和接口声明的各个部分以及它们出现的先后次序。
类/接口声明的各部分及注解（其中注释部分不是必须的）：
类或接口的声明
类/接口实现注释（/*……*/）：
该注释应包含任何关于整个类或接口的信息（，而这些信息又不适合作为类/接口文档注释。
）
类的（静态Static）变量：
首先是类的公共变量（public），随后是保护变量（protected）,再后是包一级别的变量（没有访问修饰符，accessmodifier），最后是私有变量（private）
实例（Instance）变量：
首先是公共级别的，随后是保护级别的，再后是包一级别的（没有访问修饰符），最后是私有级别的。
构造器
方法：
方法应该按功能分组，而不是按照作用域或访问权限分组。
例如，一个私有的类方法可以置于两个公有的实例方法之间。
其目的是为了更便于阅读和理解代码。
3.缩进排版（Indentation）
我们规定，4个空格常被作为缩进排版的一个单位。
3.1行长度（LineLength）
尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理。
3.2换行（WrappingLines）
当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：
在一个逗号后面断开
在一个操作符前面断开
尽量选择在较高级别（higher-level）运算之后断开，而非较低级别（lower-level）的断开
新的一行应该与上一行同一级别表达式的开头处对齐
以下是断开方法调用的一些例子：
someMethod（longExpression1,longExpression2,longExpression3,
longExpression4,longExpression5）;
var=someMethod1（longExpression1,
someMethod2（longExpression2,
longExpression3））;
longName1=longName2*（longName3+longName4-longName5）
+4*longname6;
//PREFFER
4.注释（Comments）
注释的规范：
注释目的：
注释应该使你的代码更清晰，增强程序的可读性和可维护性。
数量标准：
注释应占程序代码的比例达到20%左右，即100行程序中包含20行左右的注释。
概括性：
注释应被用来给出代码的总括以及代码自身没有提供的附加信息，它仅包含与阅读和理解程序有关的信息。
简洁性：
只对设计中重要的或者不是显而易见的地方进行说明，而避免提供代码中己清晰表达出来的重复信息。
同步修改：
修改程序代码时，一定要同时修改相关的注释，保持代码和注释的同步。
避免频繁注释：
频繁的注释有时反映出代码的低质量。
当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。
注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不会增加可执行文件的大小。
4.1注释的格式（CommentFormats）
程序可以有4种注释的风格：
块（block）、单行（single-line）、尾端（trailing）和行末（end-of-line）。
4.1.1块注释（BlockComments）
块注释通常用于提供对文件，方法，数据结构和算法的总体描述。
块注释一般被置于每个文件的开始处以及每个方法之前。
块注释之首应该有一个空行，用于把块注释和代码分割开来，并以/*-开头，比如：
Hereisablockcomment.
4.1.2单行注释（Single-LineComments）
短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。
如果一个注释不能在一行内写完，可采用块注释。
单行注释之前应该有一个空行。
4.1.3尾端注释（TrailingComments）
极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。
若有多个短注释出现于大段代码中，它们应该具有相同的缩进。
4.1.4行末注释（End-Of-LineComments）
注释界定符"
//"
，可以注释掉整行或者一行中的一部分。
而对于连续多行文本的注释，建议使用"
/**/"
。
5.声明（Declarations）
5.1每行声明变量的数量（NumberPerLine）
推荐一行一个声明，因为这样以利于写注释
不要将不同类型变量的声明放在同一行
5.2初始化（Initialization）
尽量在声明局部变量的同时初始化；
如果变量的初始值依赖于某些先前发生的计算，可在相应处进行初始。
5.3布局（Placement）
只在代码块的开始处声明变量（一个块是指任何被包含在大括号"
{"
和"
}"
中间的代码），而不要在首次用到该变量时才声明之。
因为这样会影响代码的可读性及其在该作用域内的可移植性。
该规则的一个例外是for循环的索引变量。
避免声明的局部变量覆盖上一级声明的变量。
例如，不要在内部代码块中声明与外部相同的变量名。
5.4类和接口的声明（ClassandInterfaceDeclarations）
类和接口的编写，应该遵守以下格式规则：
在方法名与其参数列表之前的左括号"
（"
间不要有空格
左大括号"
位于声明语句同行的末尾
右大括号"
另起一行，与相应的声明语句对齐，除非是一个空语句，"
应紧跟在"
之后
方法与方法之间以空行分隔
classSampleextendsObject{
intivar1;
intivar2;
Sample（inti,intj）{
ivar1=i;
ivar2=j;
}
intemptyMethod（）{}
...
}
6.语句（Statements）
6.1简单语句（SimpleStatements）
每行至多包含一条语句
6.2复合语句（CompoundStatements）
复合语句是包含在大括号中的语句序列，形如"
{语句}"
被括其中的语句应该较之复合语句缩进一个层次
应位于复合语句起始行的行尾，右大括号"
应另起一行并与复合语句首行对齐
大括号可以被用于所有语句，为了提高程序可读性也可对单个语句使用大括号，比如if-else或for控制结构
6.3if-else语句（if-elseStatements）
if-else语句应该具有如下格式：
if（condition）{
statements;
}else{
}elseif（condition）{
}else{
注意：
if语句总是用"
括起来，为避免引起错误，即使仅有一条语句也应尽量用"
括起来。
6.4for语句（forStatements）
一个for语句应该具有如下格式：
for（initialization;
condition;
update）{
一个空的for语句（所有工作都在初始化，条件判断，更新子句中完成）应该具有如下格式：
update）;
当在for语句的初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导致复杂度提高。
若需要，可以在for循环之前（为初始化子句）或for循环末尾（为更新子句）使用单独的语句。
6.5while语句（whileStatements）
一个while语句应该具有如下格式
while（condition）{
一个空的while语句应该具有如下格式：
while（condition）;
6.6do-while语句（do-whileStatements）
一个do-while语句应该具有如下格式：
do{
}while（condition）;
6.7switch语句（switchStatements）
一个switch语句应该具有如下格式：
switch（condition）{
caseABC:
/*fallsthrough*/
caseDEF:
break;
caseXYZ:
default:
每当一个case顺着往下执行时（因为没有break语句），通常应在break语句的位置添加注释。
上面的示例代码中就包含注释/*fallsthrough*/。
6.8try-catch语句（try-catchStatements）
一个try-catch语句应该具有如下格式：
try{
}catch（ExceptionClasse）{
一个try-catch语句后面也可能跟着一个finally语句，不论try代码块是否顺利执行完，它都会被执行。
}finally{
7.空白（WhiteSpace）
7.1空行（BlankLines）
空行将逻辑上相对独立的代码段分隔开，以提高可读性。
下列情况应该总是使用两个空行：
一个源文件的两个片段（section）之间
类声明和接口声明之间
下列情况应该总是使用一个空行：
两个方法之间
方法内的局部变量和方法的第一条语句之间
块注释（参见"
4.1.1"
）或单行注释（参见"
4.1.2"
）之前
一个方法内的两个逻辑段之间，用以提高可读性
7.2空格（BlankSpaces）
下列情况应该使用空格：
一个紧跟着括号的关键字应该被空格分开；
但方法名与其左括号之间不应有空格，这将有助于区分关键字和方法调用。
空白应该位于参数列表中逗号的后面
除了"
."
以外的所有的二元运算符，应该使用空格将之与操作数分开；
一元操作符和操作数之间不加空格，比如：
负号（"
-"
）、自增（"
++"
）和自减（"
--"
）。
for语句中的表达式应该被空格分开
强制转型后应该跟一个空格
参考范例如下：
while（true）{
...
}
Strings=Function1（para1,para2,para3）;
while（d++=s++）{
n++;
for（expr1;
expr2;
expr3）
myMethod（（byte）aNum,（Object）x）;
8.命名规范（NamingConventions）
规范的命名使程序更易读，从而更易于理解；
它们可以提供一些有关标识符功能的信息，使各种常量、变量、包、类、接口、方法等便于识别，以助于理解代码。
另外，应尽量避免用中文命名。
标识符类型
命名规则
范例
包（Packages）
一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO3166标准所指定的标识国家的英文双字符代码。
包名的后续部分根据不同机构各自内部的命名规范而不尽相同。
这类命名规范可能以特定目录名的组成来区分部门（department），项目（project），机器（machine），或注册名（loginnames）。
com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese
类（Classes）
类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。
尽量使你的类名简洁而富于描述。
使用完整单词，避免缩写词（除非该缩写词被更广泛使用，像URL，HTML）
classAccount;
classStudentInfo;
接口（Interfaces）
大小写规则与类名相似
interfaceRasterDelegate;
interfaceStoring;
方法（Methods）
方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
run（）;
getBackground（）;
变量（Variables）
变量名采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。
变量名应简短且富于描述；
变量名的选用应易于记忆，即能够指出其用途。
尽量避免单个字符的变量名，除非是一次性的临时变量。
临时变量通常被取名为i，j，k，m和n，它们一般用于整型；
c，d，e，它们一般用于字符型。
charc;
inti;
floatdiamondWidth;
实例变量（InstanceVariables）
大小写规则和变量名相似，除了前面需要一个下划线
int_employeeId;
Customer_customer;
常量（Constants）
类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。
（尽量避免ANSI常量，容易引起错误）
staticfinalintMIN_WIDTH=4;
staticfinalintGET_THE_CPU=1;
9.编程惯例（ProgrammingPractices）
9.1提供对实例以及类变量的访问控制（ProvidingAccesstoInstanceandClassVariables）
若没有足够理由，不要把实例变量或类变量声明为公有。
通常，实例变量无需显式的设置（set）和获取（gotten），通常这作为方法调用的边缘效应（sideeffect）而产生。
一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。
亦即，若你要使用一个结构（struct）而非一个类（如果java支持结构的话），那么把类的实例变量声明为公有是合适的。
9.2引用类变量和类方法（ReferringtoClassVariablesandMethods）
避免用一个对象访问一个类的静态变量和方法。
应该用类名替代。
classMethod（）;
//OK
AClass.classMethod（）;
anObject.classMethod（）;
//AVOID!
9.3常量（Constants）
位于for循环中作为计数器值的数字常量，除了-1,0和1之外，不应被直接写入代码。
9.4变量赋值（VariableAssignments）
避免在一个语句中给多个变量赋相同的值，这将降低程序的可读性。
不要将赋值运算符用在容易与相等关系运算符混淆的地方。
不要使用内嵌（embedded）赋值运算符试图提高运行时的效率，这是编译器的工作。
fooBar.fChar=barFoo.lchar='
'
c'
;
//AVOID!
if（c++=d++）{//AVOID!
（Javadisallows）
应该写成
if（（c++=d++）!
=0）{
d=（a=b+c）+r;
a=b+c;
d=a+r;
9.5其它惯例（MiscellaneousPractices）
9.5.1圆括号（Parentheses）
在含有多种运算符的表达式中，尽量使用圆括号来避免运算符优先级问题；
即便你对运算符的优先级很清楚，依然建议你这样做，因为这样可以提高你程序的可读性。
if（a==b&
&
c==d）//AVOID!
if（（a==b）&
（c==d））//RIGHT
9.5.2返回值（ReturningValues）
设法让你的程序结构符合目的。
if（booleanExpression）{
returntrue;
}else{
returnfalse;
应该代之以如下方法：
returnbooleanExpression;
类似地：
if（condition）{
returnx;
returny;
应该写做：
return（condition?
x:
y）;
9.5.3条件运算符"
?
"
前的表达式（Expressionsbefore'
intheConditionalOperator）
如果一个包含二元运算符的表达式出现在三元运算符"
?
:
"
的"
之前，那么应该给表达式添上一对圆括号。
（x>
=0）?
-x;
Jsp编码规范
升级会员 