1.1 目的

后缀名	意义	举例
EJB	表示这个类为EJB类	LCIssueInfoManagerEJB
Service	表明这个类是个服务类，里面包含了给其他类提同业务服务的方法	PaymentOrderService
Impl	这个类是一个实现类，而不是接口	PaymentOrderServiceImpl
Inter	这个类是一个接口	LifeCycleInter
Dao	这个类封装了数据访问方法	PaymentOrderDao
Action	直接处理页面请求，管理页面逻辑了类	UpdateOrderListAction
Listener	响应某种事件的类	PaymentSuccessListener
Event	这个类代表了某种事件	PaymentSuccessEvent
Servlet	一个Servlet	PaymentCallbackServlet
Factory	生成某种对象工厂的类	PaymentOrderFactory
Adapter	用来连接某种以前不被支持的对象的类	DatabaseLogAdapter
Job	某种按时间运行的任务	PaymentOrderCancelJob
Wrapper	这是一个包装类，为了给某个类提供没有的能力	SelectableOrderListWrapper
Bean	这是一个POJO	MenuStateBean

2.4 方法名命名规范

l 首字母小写，动词在前

动词前缀往往表达特定的含义，如下表：

前缀名	意义	举例
create	创建	createOrder()
delete	删除	deleteOrder()
add	创建，暗示新创建的对象属于某个集合	addPaidOrder()
remove	删除	removeOrder()
init或则initialize	初始化，暗示会做些诸如获取资源等特殊动作	initializeObjectPool
destroy	销毁，暗示会做些诸如释放资源的特殊动作	destroyObjectPool
open	打开	openConnection()
close	关闭	closeConnection()<
read	读取	readUserName()
write	写入	writeUserName()
get	获得	getName()
set	设置	setName()
prepare	准备	prepareOrderList()
copy	复制	copyCustomerList()
modity	修改	modifyActualTotalAmount()
calculate	数值计算	calculateCommission()
do	执行某个过程或流程	doOrderCancelJob()
dispatch	判断程序流程转向	dispatchUserRequest()
start	开始	startOrderProcessing()
stop	结束	stopOrderProcessing()
send	发送某个消息或事件	sendOrderPaidMessage()
receive	接受消息或时间	receiveOrderPaidMessgae()
respond	响应用户动作	responseOrderListItemClicked()
find	查找对象	findNewSupplier()
update	更新对象	updateCommission()

2.5 变量命名规范

l 静态常量：全大写用下划线分割

例如：

public static find String ORDER_PAID_EVENT =“ORDER_PAID_EVENT”;

l 枚举：全大写，用下划线分割

例如：

public enum Events {
ORDER_PAID,
ORDER_CREATED
}

l 其他：首字母小写，骆驼法则

例如：

public StringorderName;

l 局部变量: 参数和局部变量名首字母小写，骆驼法则

尽量不要和域冲突，尽量表达这个变量在方法中的意义。

3.排版风格

规则一：程序块采用缩进风格编写，缩进为4个空格位。排版不混合使用空格和TAB键。

规则二：在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时，如果是关系密切的立即操作符，后不应加空格。

(1) 逗号、分号只在后面加空格，例如：　

call(a,b, c);

(2) 比较操作符, 赋值操作符"="、 "+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格

if(currentTime>= MAX_TIME_VALUE)

a = b + c;

a*= 2;

a= b ^ 2;

(3) "!"、"~"、"++"、"--"等单目操作符前后不加空格

flag= !bIsEmpty; // 非操作"!"与内容之间

i++;// "++","--"与内容之间

(4) "."前后不加空格

p.id = pId; // "."前后不加空格

(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。

if(a >= b && c > d)

规则三：函数体的开始，类的定义，结构的定义，if、for、do、while、switch及case语句中的程序都应采用缩进方式

voidexample_fun( void ){

voidexample_fun( void ){

... // program code

}

规则四：功能相对独立的程序块之间或for、if、do、while、switch等语句前后应加一空行

repssn_ind= ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

repssn_ind= ssn_data[index].repssn_index;

repssn_ni = ssn_data[index].ni;

规则五：if、while、for、case、default、do等语句自占一行。

不符合规范：

If(NULL == pUserCR) return;

规则六：若语句较长(多于80字符)，可分成多行写，划分出的新行要进行适应的缩进，使排版整齐，语句可读。

规则七：一行最多写一条语句。

不符合规范：

rect.length= 0 ; rect.width = 0 ;

rect.length= width = 0;

应书写成:

rect.length= 0 ;

rect.width= 0 ;

规则八：类先成员变量，后内部函数接口；关键字public、protected、private依次按照顺序排版。

publicvoid Func1(void);

publicvoid Func2(void);

private void Func3(void);

}

规则九：编写条件的时候采用“常量==变量”格式

4.注释规则

规则一：文件级注释

/**

*<li>模块名 : LoginController

*<li>文件名 : LoginController.java

*<li>创建时间 : 2015年12月25日

*<li>实现功能 : （说明：该位置需要换行的时候结尾加上 ，以便生成的文档格式友好）

*<li>作者 : changyong

*<li>版本 : v0.0.1

*<li>----------------------------------------------------------

*<li>修改记录:

*<li>日期版本修改人修改内容

*<li>2015年12月25日 v0.0.1 changyong创建 （说明：该位置需要换行的时候结尾加上 ，以便生成的文档格式友好）

注：需记录文件内容，让人看注释就可以知道文件的大致内容；修改记录重点节点记录即可。

规则二：函数级注释

/**

*功能：

* 注释测试使用（说明：该位置需要换行的时候结尾加上 ，最后一个由于下行开始加了，这里不用加，以便生成的文档格式友好）

* ----------------------------------------------------------------

*修改记录：

*日期版本修改人修改内容

*2015年12月25日 v0.0.1 changyong创建（说明：该位置需要换行的时候结尾加上 ，最后一个由于下行开始加了，这里不用加，以便生成的文档格式友好）

* ----------------------------------------------------------------

*@param i

*@return String

注：重点函数进行记录说明，让人看了就知道函数功能，如何使用等信息；修改记录重点节点记录即可。

规则三：语句及函数内部结构注释

为了方便阅读代码尽可能的多做一些注释，特别是关键点一定要注释，但是也不要过于冗余盲目的注释，尽量达到注释即为大纲的效果。

团队开发之：代码规范说明相关推荐

小团队的前端代码规范
前端代码规范文章目录前端代码规范 1 前言 2 命名规范 1) 项目命名 2 )目录命名 3)`javaScript` 文件命名 4)`CSS`,`less`文件命名 5)HTML文件命名 6) ...
团队开发之Git管理及使用
什么是Git 以下摘自官网: Git is a free and open source distributed version control system designed to handle e ...
ios开发之 icon规范+启动图规范+启动页规范
作为一名开发人员,有时候碰上美工有事外出,那么偶尔就得顶下美工的岗位,切切图.今天就简单的说一下. 手机以(iPhone 4s-iPhone 6P)为主,若有新产品,会及时更新内容. 1.先说说App ...
手机开发之H5+规范的手机按键处理
手机开发中,默认的手机按键处理方式都是直接退出程序.在实际中,手机开发者往往都需要进行自定义处理,而处理这些需要牵涉到手机端的原生控件的处理或者调用,这对于通过WEB方式开发手机应用来说,是一个难题. ...
项目Alpha冲刺（团队）-代码规范、冲刺任务与计划
课程名称:软件工程1916|W(福州大学) 作业要求:项目Alpha冲刺(团队)-代码规范.冲刺任务与计划团队名称:SkyReach 作业目标:确定团队项目的代码规范.冲刺任务与计划代码规范:隐流 ...
Java代码规范检查插件调研及总结
代码规范工具对比代码规范工具是什么大家应该都有过写完代码后review的情况:用于提高编码质量,尽早的发现问题:节约开发时间和成本. 但review 这个过程往往要消耗更多的开发资源. 所以就出 ...
【项目篇】Android团队项目开发之统一代码规范
前言团队项目开发前的统一三要素:统一需求/开发文档,统一代码规范,统一环境(编译/测试/发布). 一个项目团队,要想有高效的产出,必须在团队协作上下好功夫,必须在项目开发统一进度上做好协调.只有在高 ...
镜像处理坐标 android,Android应用开发之Android重写ImageView实现图片镜像效果的代码教程...
本文将带你了解Android应用开发之Android重写ImageView实现图片镜像效果的代码教程,希望本文对大家学Android有所帮助. 前两天朋友问我一个问题,如何实现从手机系统相册加载一张图 ...

团队开发之：代码规范说明

1.1 目的

1.2 范围

1.3 术语

1.4 参考文档

2.标示符命名规范

2.1 原则

2.2 包名规范

2.3 类名命名规范

2.4 方法名命名规范

2.5 变量命名规范

3.排版风格

4.注释规则

团队开发之：代码规范说明相关推荐

最新文章

热门文章