java 代码规范 sun 公司
命名规范(Naming Convention)
1包(Packages)
一个唯一包名的前缀总是全部小写的ASCⅡ字母并且是一个顶级域名,通常是com,gov,edu,mil,net,org,或1981年ISO 3166标准所指定的标识的国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department),项目(project),机器(machine),或注册名(login names)。
例如:
com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese
2类(Classes)
类名是一个名词,采用大小写混合方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被广泛的使用,如URL,HTML)。
例如:
class Raster
class ImageSprite
3接口(Interfaces)
interface RasterDelegate
interface Storing
4方法(Methods)
方法名是一个动词,采用大小写混合方式,第一个单词的首字母小写,其后单词的首字母大写。
例如:
run()
runFase()
getBackground()
5变量(Variables)
这里变量指方法内局部变量,临时变量。除了变量名外,所有实例,包括类,类常量,均采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。
例如:
char c
int i
float myWidth
6实例变量(Instance Variables)
在类的声明中,属性是用变量来表示的,这种变量就称为实例变量。实例变量名以m开头且应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一个性临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整形;c,d,e,它们一般用于字符型。
int mEmployeeld
String mName
Customer mCustomer
7常量(Constants)
全部字母大写,单词以下划线分割。尽量避免ANSI常量,容易引起错误。
例如:
static final int MIN_WIDTH = 4
static final int MAX_WIDTH = 999
static final int GET_THE_CPU = 1
命名规范使程序更易读,从而更易于理解。它们也可以提供一些有关标识符功能的信息,以助于理解代码。例如,不论它是一个常量、包,还是类(如9.7的例子所示)。
类和接口的声明(Class and Interface Declarations)
当编写类和接口时,应该遵守以下格式规则:1
◆ 在方法名与其参数列表之前的左括号“(”间不要有空格。
◆ 左大括号“{”位于声明语句同行的末尾。
◆ 右大括号“}”另起一行,与相应的声明语句对齐,除非是一个空语句,“}”应紧跟在“{”之后。
class Sample extends Object {
int ivar1;
int ivar2;
Sample(int i, int j) {
ivar1 = i;
ivar2 = j;
}
int emptyMethod() {}
…
}
方法与方法之间 以空行分隔。
语句(Statements)
1 简单语句(Single Statement)
每行至多包含一条语句,例如:
argv++; // Correct
argc--; // Correct
argv++; argc--; // AVOID!
2 复合语句(Compound Statements)
复合语句是包含在大括号中的语句序列,形如“{ 语句 }”。例如下面各段。
◆ 被括其中的语句应该较之复合语句缩进一个层次。
◆ 左大括号“{”应位于复合语句起始行的行尾;右大括号“}”应另起一行并与复合语句首行对齐。
◆ 大括号可以被用于所有语句,包括单个语句,只要这些语句是诸如if – else或for控制结构的一部分。这样便于添加语句而无需担心由于忘了加括号而引入bug.
2.1 if, if-else, if else-if else语句(if, if-else, if else-if else Statements)
if-else语句应该具有如下格式:
if (condition) {
statements;
}
if (condition) {
statements;
} else {
statements;
}
if (condition) {
statements;
} else if (condition) {
statements;
} else if (condition) {
statements;
}
注意:if语句问题用“{”和“}”括起来,单行也是如此,避免使用如下容易引起错误的格式:
if (condition) // AVOI! THIS OMITS THE BRACES {}!
statement;
2.2 switch语句(switch Statements)
一个switch语句应该具有如下格式:
switch (condition) {
case ABC:
statements;
/ * falls through */
case DEF:
statements;
break;
case XYZ:
statements;
break;
}
每当一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释。上面的示例代码中就包含注释/ * falls through */。
2.3 try-catch语句(try-catch Statements)
一个try-catch语句应该具有如下格式:
try {
statements;
} catch (ExceptionClass e) {
statements;
}
一个try-catch语句后面也可能跟着一个finally语句,不论try代码块是否顺利执行完,它都会被执行。
try {
statements;
} catch (ExceptionClass e) {
statements;
} finally {
statements;
}
郑重声明:本站内容如果来自互联网及其他传播媒体,其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享,并不代表本站赞同其观点和对其真实性负责,也不构成任何其他建议。