Java代码标准说明.doc

 1. 环境配置 2 1.1. 软件 2 1.2. 项目导入 2 1.3. 项目编码配置 3 2. 项目通用命名规则 6 2.1. 命名方式 6 2.2. 方法命名规则 6 2.3. 变量命名规则 6 2.4. 常量命名规则 7 2.5. 注释 7 2.6. 注释范围 8 2.7. Controller、Service、Dao 等中的方法命名 9 2.8. JSP页面命名 10 3. 代码书写规范 10 3.1. 返回值 10 3.2. 异常 11 3.3. 换行(Wrapping Lines) 13 3.4. 声明(Declaration) 14 3.5. 初始化(Initialization) 15 3.6. 布局(Placement) 15 3.7. 简单语句(Single Statement) 16 3.8. 复合语句(Compound Statements) 16 3.9. 返回语句(return Statements) 16 3.10. for语句(for Statements) 17 3.11. while语句switch(while Statements) 17 3.12. 空行(Blank Lines) 18 3.13. 空格(Blank Spaces) 18 3.14. 圆括号(Parentheses) 19 3.15. 变量赋值(Variable Assignments) 20 3.16. 去除警告 20 4. 代码质量 21 4.1. 统一编码规范、代码样式 21 4.2. 静态代码分析 21 4.3. 单元测试 21 4.4. 持续集成 22 4.5. 代码评审和重构 22  环境配置 软件 软件名称 版本 备注 Myeclipse 6.5 试用版 JDK Jdk.1.6.0_45 sunJDK开源 Tomcat 6.0.37 Apache开源 Mysql 5.0.18/5.1 开源 SQLyog 9.6.2 试用版 SVN subeclipse-site-1.6.5 插件 SVN客户端 TortoiseSVN 1.6.7 插件 项目导入 1、 选择SVN地址 输入帐号密码 完成即可 项目编码配置 文项目所有编码格式统一采用UTF-8 设置 修改types 和methods注释的方法 修改以上则类名自动加注释，需要修改里边的信息 方法名注释：在方法的前面输入” /** ” b然后回车自动出现注释调整样式即可。 项目通用命名规则 命名方式 文件名、变量名称使用有意义的英文（或缩写）进行命名，名称与数据表结构的名称命名保持一致，便于提高查阅效率。所有由多个单词组成的名称统一用驼峰法则进行命名。驼峰法则是由一个或多个单字连结在一起，而构成的唯一识别字时，第一个单字以小写字母开始，第二个单字的首字母大写或每一个单字的首字母都采用大写字母，例如： 业务名称为角色，则命名为 RoleController 、RoleServiceImpl 、findUniqueEntity 等。所有的命名根据业务名称的英文或者中文拼音，优先采用英文。 方法命名规则 方法名应是一个动词或动名结构，采用大小写混和的方式，其中第一个单词的首字母用小写，其后单词的首字母大写。例如： Xxxxx.getBmList()； 每个方法前必须加说明包括：参数说明、返回值说明、异常说明。如果方法名实在是太长可以对变量名缩写，但是必须添加相应的说明。 变量命名规则 变量命名一般采用大小写混和的方式，第一个单词的首字母小写，其后单词的首字母大写，变量名一般不要用下划线或美元符号开头。变量名应简短且有意义，即，能够指出其用途。除非是一次性的临时变量，应尽量避免单个字符的变量名。 （1）类的实例对象定义如下： Person person; （2）同一个类的多个对象可以采用一下定义方式： Person person1； Person person2； （3）集合类的实例命名使用集合包含元素的英文名称的复数表示，例如： Vector persons; （4）如果变量名实在是太长可以对变量名缩写，但是必须在类说明或方法说明部分（视缩写的范围而定）进行说明。 （5）数组的声明要用int[] packets的形式，而不要用int packets[]。 常量命名规则 类常量和ANSI常量的命名应全部用大写，单词间用下划线隔开。例如： final static int MIN_WIDTH = 4； 注释 Java程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是那些在C++中见过的，使用/*…*/和//界定的注释。文档注释(被称