没有合适的资源?快使用搜索试试~ 我知道了~
java企业级编程规范
4星 · 超过85%的资源 需积分: 9 41 下载量 70 浏览量
2008-11-24
10:01:05
上传
评论
收藏 62KB DOC 举报
温馨提示
试读
13页
java企业级编程规范java企业级编程规范java企业级编程规范java企业级编程规范java企业级编程规范java企业级编程规范java企业级编程规范java企业级编程规范java企业级编程规范java企业级编程规范
资源推荐
资源详情
资源评论
在前一阶段的工作中,由于项目时间太紧,为了赶进度,也就未对编码人员做过多的
约束。在这里,就我对 j2ee 项目编码要求的理解加上一些我在前一阶段发现的问题做了一
些整理,先做为本项目阶段的编码注意事项。希望大家多提宝贵意见,对其不断完善,最
终形成我公司的规范文件。
一、JAVA 代码编写注意事项
存取函数
使用存取函数获得和修改所有字段
一旦可能,将存取函数置为被保护类型,不是公共类型
字段
字段永远为私有类型
不要直接访问字段,应使用存取成员函数
不要使用静态常量字段(常量),应使用存取成员函数
一定要初始化静态字段
类
最小化公共和保护接口 【决不将不该公开的方法定义为 public 型】
在开始写代码之前定义好一个类的公共接口
局部变量
1、 一行代码只声明一个局部变量
2、 用一个行内注释说明局部变量
3、 在使用局部变量之前声明它
4、 仅将局部变量用于一件事
成员函数 给代码加上注释
1、 给代码分段
2、 使用空白,控制结构之前用一个空行,成员函数之前用两个空行
3、 一个成员函数应能在 30 秒内让人理解
4、 尽量限制成员函数的可见性
5、 说明操作的顺序
注释至少要有以下内容:
/**
*@param
*@return
* @see
*/
标准的命名习惯
类名首字母应该大写。字段、方法以及对象(句柄)的首字母应小写。对于所有标识
符,其中包含的所有单词(英文单词)都应紧靠在一起,而且大写中间单词的首字母。例
如:
ThisIsAClassName
thisIsMethodOrFieldName
使用缩写时应尽可能遵循项目缩写字典,若你的缩写词在项目缩写字典中不存在,请
自觉添加。在项目缩写字典一般放在工程的根目录下,名字为“××项目-缩写字典.doc”
避免使用"魔术数字"。
这些数字很难与代码很好地配合。如以后需要修改它,无疑会成为一场噩梦,因为根
本不知道"100"到底是指"数组大小"还是"其他全然不同的东西"。所以,我们应创建一个常
数,并为其使用具有说服力的描述性名称,并在整个程序中都采用常数标识符。这样可使
程序更易理解以及更易维护。若在定义中出现了常数初始化字符,则大写 static final 基本
类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。
1、 如 Session 中 属 性 的 名 字 应 该 放 在 常 量 定 义 接 口 文 件 【 如
com.jy.fullcar.util.SessionConstants.java】中。
2、 象 EJB 的 JNDI NAME 以及数据源 Datasource 的 JNDI NAME 都不能在代码里面直
接“硬”编码,应该在专用的常量定义文件【如 com.jy.fullcar.util.JNDINames.java】中。
3、 其 它 类 型 的 常 量 应 该 放 到 常 量 定 义 接 口 文 件 【 如
com.jy.fullcar.util.SystemConstants.java】中。
坚决杜绝随意使用包名
Java 包(Package)的名字全都是小写字母,即便中间的单词亦是如此。对于域名扩展
名称,如 com,org,net 或者 edu 等,全部都应小写。 最好采用 com+公司的域名逆序(或
公司名缩写)+<项目名>+”<模块名>”+<子模块名>来组织..。如
com.jy.util----------------------------------精友公司工具库(与具体项目无关)
com.jy.crm.util------------------------------精友公司 CRM 工具库(与具体项目无关)
com.jy.crm.custommanager.util------------------------------精友公司 CRM 项目客户管理子系
统(模块)工具库(与具体项目无关)
注意:包的深度最好不大于 6 层。
新类的"经典形式"创建
为了常规用途而创建一个类时,请采取"经典形式",并包含对下述元素的定义:
equals()
hashCode()
toString()
clone()(implement Cloneable)
implement Serializable
注意:implement Serializable 非常重要。尤其存在远程调用和使用 EJB 的时候
一个方法只做一件事
应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分。理
想情况下,方法应简明扼要。若长度很大,可考虑通过某种方式将其分割成较短的几个方
法。这样做也便于类内代码的重复使用(有些时候,方法必须非常大,但它们仍应只做同
样的一件事情)。
剩余12页未读,继续阅读
资源评论
- mikeshu2012-07-28整理的资料不错,可以做编程规范参考~!
tutu417
- 粉丝: 0
- 资源: 2
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 基于CSS的响应式鲜花网站全屏效果设计源码
- 基于JavaScript的访客预约系统设计源码
- 基于Vue和ECharts的工作租房数据可视化系统设计源码
- 1040g0cg310ravpiu6ibg5pg00tsipsln3ju2d0g 2
- 基于Python的SAR图像去噪CNN-NLM设计源码
- redhat6升级到redhat7,过程redhat6.x-> redhat6.10->rehat7.9 主版本最高版本
- 基于Django的流程引擎设计源码
- 基于Node.js的Express框架与MySQL的后台管理系统设计源码
- 基于Java的Flink流批一体数据处理快速集成开发框架设计源码
- FirstFilterOrderCompare
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功