JAVA编码规范文档较专业Word文件下载.docx
- 文档编号:13733385
- 上传时间:2022-10-13
- 格式:DOCX
- 页数:27
- 大小:33.21KB
JAVA编码规范文档较专业Word文件下载.docx
《JAVA编码规范文档较专业Word文件下载.docx》由会员分享,可在线阅读,更多相关《JAVA编码规范文档较专业Word文件下载.docx(27页珍藏版)》请在冰豆网上搜索。
HIS_IS_A_CONSTANT
除常量外的命名采用大小写混合,提高名字的可读性。
一般采用小写字母,但是类和接口的名字的首字母,以及任何中间单词的首字母应该大写。
2.1.4少用缩写
少用缩写,如果要用,给单词指定唯一的缩写。
比如如果“number”被缩写成“num”,那就不要同时使用“no”作为它的缩写。
2.1.5避免使用长的名字(15字符以内)
命名不要超过标识符最大字符数,虽然PhysicalOrVirtualProductOrService看起来似乎是个不错的类名,但是这个名字太长了,应该考虑重新给它起个短一点的名字,比如象Offering。
2.1.6避免使用仅在大小写上有差异的命名
比如“VariableName”不要和“VariableNames”一起用;
“SQLDatabase”不要和“sqlDatabase”一起用。
2.1.7对首字母缩写词的使用
对首字母缩写词的使用,仅仅大写它的第一个字,比如把“crmDatabase”作为变量名好于“cRMDatabase”,把“CrmDatabase”作为类名好于“CRMDatabase”。
2.1.8下划线的使用
避免使用下划线作为名字的首末字母,以下划线为首末字母的名字通常为系统保留,除预处理定义之外,一般不用作用户命名。
因此建议下划线只用在常量的命名的单词中间作分隔符。
2.2标识符的命名规则
标识符类型
命名规则
示例
Packages
每一个包的名称总是小写且为单数;
包命名格式建议采用类似于TCP/IP中域名的反序,即com.ce+<
项目英文简写>
+…,
其后的部分由项目经理定义。
com.ce.beafront
com.ce.beaproduct
com.ce.framework
com.ce.beateller
com.ce.beafront.service
Classes
类名必须是名词;
每个单词首字母大写;
类名应该简单清晰,不要使用非通用缩写。
类名:
Raster
ImageSprite
EJB类名,在类名后加“EJB”:
ProcessManagerEJB
JavaBean类名,在类名后加“Bean”:
ProcessServiceBean
DataAccessObject类名,在类名后加“DAO”:
CustomersDAO
运行在Integrator中的扩展服务类名,类名需用动词,且类名后加“Service”:
GetBalanceService
Interfaces
同类名规则一样。
接口名:
RasterDelegate
Storing
Remote接口,用普通描述性文字命名:
子系统接口,在接口名后加“INF”或在前面加“I”:
ICustomers
CustomersINF
Home接口,在接口名后加Home:
CustomersHome
Methods
方法应该是动词,或以动词开始的动宾结构短语,除第一个单词外,每个单词的首字母大写。
方法名:
runFast()
构造方法,与类名相同:
Customer()
设置方法,被访问字段名的前面加上前缀set:
setFirstName()
setLastName()
获取方法,被访问字段名的前面加上前缀get:
getFirstName()
getLastName()
布尔型的获取方法,用is做前缀:
isString()
对配置成Service的服务类(配置在Spring中,处理业务逻辑的类,一般此类实现的接口以Service为后缀),进行数据库操作(增删改)时方法的命名分别以insert、delete、update和save为前缀:
insertAccount()
Variables
变量名应该短而准确并便于记忆;
采用匈牙利命名法(Hungarynnaming),以一个小写字母开头,后面的每个单词的首字母大写;
除了临时使用的如循环变量以外,不要使用单字符的变量名;
对于使用单字符的临时变量名,建议循环变量名用i,j,k,n表示整数,c,d,e表示字符。
表示数组类型
charachName[20]
表示字符数据类型
charchTemp
表示int类型
intiNumber
表示Byte类型
BytebGet
表示short类型
ShortsNumber
表示long类型
longlNumber
表示float类型
FloatfCount
表示double类型
doubledPrice
表示String类型
StringstrSend
表示StringBuffer类型
StringBufferstrbRecieve
表示boolean类型
booleanbFlag
表示Vector类型
VectorvTableOrder
表示Collection类型
CollectioncTableOrder
Constants
全部大写,单词之间用下划线分隔。
staticfinalintMIN_WIDTH=4;
staticfinalintMAX_WIDTH=999;
staticfinalintGET_THE_CPU=1;
Exception
用变量名“e”表示Exception,用“ioe”表示IOException
catch(IOExceptionioe){}
catch(AnyOtherExceptionaoe){}
catch(Exceptione){}
2.3非强制的一些命名规则
类型
抽象类
以Abstract开始
AbstractDjinn,AbstractCat,AbstractClass,AbstractPlayer
Factory类
以Factory结束
DjinnFactory,CatFactory,ClassFactory,PlayerFactor
实现类
以Impl结束
DjinnImpl,CatImpl,ClassImpl,PlayerImpl
Interface
以Interface结束或加-able后缀
DjinnInterface,CatInterface,Runnable,RemoteLoadable
3格式规范
3.1通用格式
一种提高代码可读性的方法是给代码分段,换句话说,就是在代码块内让代码缩进。
所有在括号{和}之内的代码,构成一个块。
基本思想是,块内的代码都应统一地缩进去一个单位。
3.1.1{}对
{}中的语句应该单独作为一行,“}”语句永远单独作为一行,“}”语句应该缩进到与其相对应的“{”那一行相对齐的位置。
例:
if(i>
0){i++};
//错误,{和}在同一行
0){
i++
};
//正确
3.1.2圆括号
在表达式、方法调用及方法声明中圆括号“(”后及“)”前不应该有空格。
CallProc(AParameter);
//错误
CallProc(AParameter);
不要在语句中使用无意义的括号.括号只应该为达到某种目的而出现在源代码中。
下面的例子说明错误和正确的用法:
if((I)=42){//错误-括号毫无意义
if(I==42)or(J==42){//正确-的确需要括号
3.1.3缩进
同级之间在同一个缩进位置,下一级与上一级之间需要缩进,缩进应该是每行4个字符,不要在源文件中保存Tab字符。
在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。
3.1.4空白行
在代码中使用空白。
在Java代码中加入几个空行,也叫空白,将代码分为一些小的、容易理解的部分,可以使它更加可读。
建议采用一个空行来分隔代码的逻辑组,例如控制结构,采用两个空行来分隔方法定义。
没有空白的代码很难读,很难理解。
✧包和引入之间加一个空行
✧不同可见性的变量定义之间加一个空行
✧方法定义之间加一个空行
✧不同可见性的方法组定义之间多加一个空行
✧在方法的局部变量声明和语句之间加一个空行
voidmethod1(){
//Declaration
intanInt=0;
StringaString=null;
ObjectanObj=null;
//Actualworkdonehere
if(condition){
****:
}
3.1.5空格
✧不要在一元操作符间留空隙。
i++好于i++
✧在二元操作符和逻辑操作符两端各留一个空格。
i+j好于i+ji>
j好于i>
j
✧在关键词if,while,for,switch,return,catch和throw后加一个空格。
if(condition)好于if(condition)
✧在每个函数参数之间的逗号后面加一个空格。
intgetResult(intforInt,charforChar)好于intgetResult(intforInt,charforChar)
✧函数名和其后的括号之间不应有空格。
newString("
String"
)好于newString("
)
✧大括号开始之前应有一个空格进行分隔。
✧所有的二元操作符的前后均应有一个空格,二元操作符的例子有加号,除号,等于符号,赋值符号等。
a+b好于a+b
✧for的每一个语句之间应有空格。
for(expr1;
expr2;
expr3)
✧强制类型转换的括号之后应有一个空格。
myMethod((byte)aNum,(Object)x);
myMethod((int)(cp+5),((int)(i+3))+1);
3.1.6页宽
页宽应该
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- JAVA 编码 规范 文档 专业
![提示](https://static.bdocx.com/images/bang_tan.gif)