没有合适的资源?快使用搜索试试~ 我知道了~
java编码规范文档.pdf
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 31 浏览量
2023-08-15
22:51:02
上传
评论
收藏 738KB PDF 举报
温馨提示
试读
22页
java编码规范文档.pdf
资源推荐
资源详情
资源评论
______________________________________________________________________________________________________________
-可编辑修改-
Java 代码规范
1. 标识符命名规范
1.1 简洁
简洁是指,在统一和达意的前提下,用尽量少的标识符。如果不能达意,宁愿不要简洁。比
如:theOrderNameOfTheTargetSupplierWhichIsTransfered 太长,
transferedTargetSupplierOrderName 则较好,但是 transTgtSplOrdNm 就不好了。省略元音的缩
写方式不要使用,我们的英语往往还没有好到看得懂奇怪的缩写。
1.2 英文 vs 拼音
尽量使用通俗易懂的英文单词,如果不会可以向队友求助,实在不行则使用汉语拼音,避免
拼音与英文混用。比如表示归档,用 archive 比较好, 用 pigeonhole 则不好,用 guiDang 尚可
接受。
1.3 包名
使用小写字母如 com.xxx.settlment,不要 com.xxx.Settlement
单词间不要用字符隔开,比如 com.xxx.settlment.jsfutil,而不要 com.xxx.settlement.jsf_util
1.4 类名
1.4.1 首字母大写
类名要首字母大写,比如 SupplierService, PaymentOrderAction;不要 supplierService,
paymentOrderAction.
1.5 方法名
首字母小写,如 addOrder() 不要 AddOrder()
动词在前,如 addOrder(),不要 orderAdd()
名称不要太长
动词前缀往往表达特定的含义,如下表:
前缀名 意义 举例
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()
find 方法在业务层尽量表达业务含义,比如 findUnsettledOrders(),查询未结算订单,而不要
findOrdersByStatus()。 数据访问层,find,update 等方法可以表达要执行的 sql,比如
findByStatusAndSupplierIdOrderByName(Status.PAID, 345)
1.6 域(field)名
1.6.1 静态常量
______________________________________________________________________________________________________________
-可编辑修改-
全大写用下划线分割,如
public static find String ORDER_PAID_EVENT = “ORDER_PAID_EVENT”;
1.6.2 枚举
全大写,用下划线分割,如
public enum Events {
ORDER_PAID,
ORDER_CREATED
}
1.6.3 其他
首字母小写,骆驼法则,如:
public String orderName;
1.7 局部变量名
参数和局部变量名首字母小写,骆驼法则。尽量不要和域冲突,尽量表达这个变量在方法中
的意义。
2. 代码格式
用空格字符缩进源代码,不要用 tab,每个缩进 4 个空格。
2.1 包的导入
删除不用的导入,尽量不要使用整个包的导入。在 eclipse 下经常使用快捷键 ctrl+shift+o 修
正导入。
2.2 域格式
每行只能声明一个域。
域的声明用空行隔开。
2.3 代码块格式
2.4.1 缩进风格
______________________________________________________________________________________________________________
-可编辑修改-
大括号的开始在代码块开始的行尾,闭合在和代码块同一缩进的行首,例如:
package com.test;
public class TestStyle extends SomeClass implements AppleInter, BananaInter {
public static finalfinal
private static void main(String[] args) {
int localVariable = 0;
}
public void compute(String arg) {
if (arg.length() > 0) {
System.out.println(arg);
}
for (int i = 0; i < 10; i++) {
System.out.println(arg);
}
while (condition) {
}
do {
otherMethod();
______________________________________________________________________________________________________________
-可编辑修改-
} while (condition);
switch (i) {
case 0:
callFunction();
break;
case 1:
callFunctionb();
break;
default:
break;
}
}
}
2.4.2 空格的使用
2.4.2.1 表示分割时用一个空格
不能这样:
if ( a > b ) {
//do something here
};
2.4.2.2 二元三元运算符两边用一个空格隔开
如下:
剩余21页未读,继续阅读
资源评论
hhappy0123456789
- 粉丝: 61
- 资源: 5万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功