《Java代码标准说明》由会员分享，可在线阅读，更多相关《Java代码标准说明（24页珍藏版）》请在金锄头文库上搜索。
1、Java代码标准说明 1. 环境配置21.1. 软件21.2. 项目导入21.3. 项目编码配置32. 项目通用命名规则62.1. 命名方式62.2. 方法命名规则62.3. 变量命名规则62.4. 常量命名规则72.5. 注释72.6. 注释范围82.7. Controller、Service、Dao 等中的方法命名92.8. JSP页面命名103. 代码书写规范103.1. 返回值103.2. 异常113.3. 换行(Wrapping Lines)133.4. 声明(Declaration)143.5. 初始化(Initialization)153.6. 布局(Placement)153.
2、7. 简单语句(Single Statement)163.8. 复合语句(Compound Statements)163.9. 返回语句(return Statements)163.10. for语句(for Statements)173.11. while语句switch(while Statements)173.12. 空行(Blank Lines)183.13. 空格(Blank Spaces)183.14. 圆括号(Parentheses)193.15. 变量赋值(Variable Assignments)203.16. 去除警告204. 代码质量214.1. 统一编码规范、代码样式2
3、14.2. 静态代码分析214.3. 单元测试214.4. 持续集成224.5. 代码评审和重构221. 环境配置1.1. 软件软件名称版本备注Myeclipse6.5试用版JDKJdk.1.6.0_45sunJDK开源Tomcat6.0.37Apache开源Mysql5.0.18/5.1开源SQLyog9.6.2试用版SVNsubeclipse-site-1.6.5插件SVN客户端TortoiseSVN 1.6.7插件1.2. 项目导入1、选择SVN地址 输入帐号密码完成即可1.3. 项目编码配置文项目所有编码格式统一采用UTF-8 设置修改types 和methods注释的方法修改以上则类
4、名自动加注释，需要修改里边的信息 方法名注释：在方法的前面输入” /* ” b然后回车自动出现注释调整样式即可。 2. 项目通用命名规则2.1. 命名方式文件名、变量名称使用有意义的英文（或缩写）进行命名，名称与数据表结构的名称命名保持一致，便于提高查阅效率。所有由多个单词组成的名称统一用驼峰法则进行命名。驼峰法则是由一个或多个单字连结在一起，而构成的唯一识别字时，第一个单字以小写字母开始，第二个单字的首字母大写或每一个单字的首字母都采用大写字母，例如： 业务名称为角色，则命名为 RoleController 、RoleServiceImpl 、findUniqueEntity 等。所有的命名
5、根据业务名称的英文或者中文拼音，优先采用英文。2.2. 方法命名规则方法名应是一个动词或动名结构，采用大小写混和的方式，其中第一个单词的首字母用小写，其后单词的首字母大写。例如：Xxxxx.getBmList()；每个方法前必须加说明包括：参数说明、返回值说明、异常说明。如果方法名实在是太长可以对变量名缩写，但是必须添加相应的说明。2.3. 变量命名规则变量命名一般采用大小写混和的方式，第一个单词的首字母小写，其后单词的首字母大写，变量名一般不要用下划线或美元符号开头。变量名应简短且有意义，即，能够指出其用途。除非是一次性的临时变量，应尽量避免单个字符的变量名。（1）类的实例对象定义如下：Pe
6、rson person;（2）同一个类的多个对象可以采用一下定义方式：Person person1；Person person2；（3）集合类的实例命名使用集合包含元素的英文名称的复数表示，例如：Vector persons;（4）如果变量名实在是太长可以对变量名缩写，但是必须在类说明或方法说明部分（视缩写的范围而定）进行说明。（5）数组的声明要用int packets的形式，而不要用int packets。2.4. 常量命名规则类常量和ANSI常量的命名应全部用大写，单词间用下划线隔开。例如：final static int MIN_WIDTH = 4；2.5. 注释Java程序有两类注释：
7、实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在C+中见过的，使用/*/和/界定的注释。文档注释(被称为“doc comments”)是Java独有的，并由/*/界定。文档注释可以通过javadoc工具转换成HTML文件。实现注释用以注释代码或或者实现细节。文档注释从实现自由(implemtentation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂。注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。例如，相应的包如何被建立或位于哪个目录
8、下之类的信息不应包括在注释中。在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中已清晰表达出来的重复信息，多余的注释很容易过时。通常应避免那些代码更新就可能过时的注释。类以及类中的每个方法必须有注释。方法中的代码关键部分必须有注释，解释代码的意思。 文本注释 类注释 /* * function: 增删改查组件规范接口 * project Xcj * package com.xcj.admin.base * fileName BaseDao.java * createDate 2010-03-30 下午05:28:03 * author xx_xx * ema
9、il */ 类中方法注释 /* * function: 增加一个entity对象，返回是否添加成功 * createDate 2010-03-30 下午05:28:38 * author su_jian * param 对象类型 * param entity 对象 * return boolean true/false * throws DataAccessException */ 单行注释/获取系统管理员的所有权限2.6. 注释范围 a) 类的方法名和类名必须有注释。例如 /* * function: 增加一个entity对象，返回是否添加成功 * createDate 2014-03-3
10、0 下午05:28:38 * author su_jian * param 对象类型 * param entity 对象 * return boolean true/false * throws DataAccessException */ b) 类调用的方法以及关键代码注释。例如/进行静态化处理staticService.buidSingleArticle(article.getId();/生成二维码图片staticService.buidQRcode(article.getId(); c) 配置文件（Spring、DB、等）代码注释。例如 $c3p0.initialPoolSize $c3
11、p0.minPoolSize2.7. Controller、Service、Dao 等中的方法命名方法类型命名规则举例（参数自己定义）初始化init+操作对象init ()新增save+操作对象save()、saveObject()删除del+操作对象sdel()、delObject ()修改update+操作对象update()、updateObject ()新增+修改edit+操作对象edit()、editObject ()查看view+操作对象view()、viewObject ()获取单个对象get+操作对象get()、getObject ()获取列表数据getListBypage+操
12、作对象sgetXxListByPage()获取集合数据getXList+操作对象sgetXxList()、getXxList Object()获取树形数据getXTree+操作对象sgetXxTree()、getXxTreeObject ()前后插入save(Before/After)+操作对象 saveObject ()/saveBeforeObject ()禁用disabled+操作对象disabled()、disabledObject()启用或激活active+操作对象sactive()、activeObject()授权assign+操作对象sassign()、assignObject
13、()撤销unassign+操作对象sunassign()、unassignObject ().2.8. JSP页面命名页面类型命名规则举例（参数自己定义）主页操作对象index.jspobjectindex.jsp新增页面操作对象save .jspobjectsave.jsp修改页面操作对象edit.jspobjectedit.jsp查看页面操作对象detail.jspobjectdetail.jsp授权操作对象assign.jspobjectassign.jsp. 3. 代码书写规范类的方法的代码行数不能过长，尽量控制在100行（90%），长的方法要拆分成私有函数。3.1. 返回值返回值的情况，如果只需要一个对象里边的属性值，则无需返回整个对象。返回值就行。 在一般情况下，方法返回值
