Java软件编程规范说明书解说.docVIP

山海经纬研发中心 Java软件编程规范说明书 文档编号 SHJW_F_YFZX_004 版本号 V1.0 总页数 23页 编 写 曹五丰 审核 王生 批准 李强 生效日期 2008-06 北京山海经纬信息技术有限公司 二零零八年六月 修改记录 版本号 变更控制报告 编号 更改条款及内容 更改人 审批人 更改日期 1.0 　文件审核版本发布 曹五丰 王生 　 　 　 　 　 　 　 　 　 　 　 　 目录 1 引言 5 2 编码规范 5 2.1 Java编码规范 5 2.1.1 命名规范 5 Package 的命名 5 Class 的命名 5 Class 变量的命名 6 Static Final 变量的命名 6 参数的命名 6 数组的命名 6 方法的参数 6 2.1.2 变量定义规范 6 2.1.3 代码编写格式 7 2.1.4 注释规范 8 2.1.5 函数、过程 9 2.1.6 编程技巧 10 byte 数组转换到 characters 10 Utility 类 10 初始化 10 枚举类型 10 2.1.7 程序编写规范 11 exit() 11 异常 11 垃圾收集 11 Clone 12 final 类 12 访问类的成员变量 12 2.1.8排版规范 13 2.1.9 Java文件格式 13 版权信息 13 Package/Imports 14 Class 14 Class Fields 14 存取方法 15 构造函数 15 类方法 16 toString 方法 16 main 方法 17 2.1.10 可读性 17 2.1.11 性能 17 不必要的对象构造 17 使用 StringBuffer 对象 17 避免太多的使用 synchronized 关键字 18 2.1.12 可移植性 18 换 行 18 PrintStream 18 2.1.13 代码测试、维护 18 2.1.14 质量保证 19 2.1.15 代码编译 20 2.2 Jsp编码规范 20 2.3 Struts编码规范 21 2.3.1 Action,Form,Bean命名规则 21 Action：命名以Action结尾, 21 Form：命名以Form结尾, 22 Bean: 命名以Bean结尾， 22 2.3.2 struts-config.xml的定义规则 22 form属性定义规则 22 action属性定义规则 22 1 引言 代码规范相当重要. 代码规范提高软件代码的可读性 , 使得开发人员快速和彻底的理解新代码. 好的代码风格不仅会提高可读性 ,而且会使代码更健壮 , 更为重要的是在修改时不容易出错. 在现代软件开发中 ,维护工作会占用80%的时间 , 而且开发者和维护者通常不是同一个程序员. 这意味着你经常要阅读和修改别人开发的程序 , 别人也同样可能需要阅读和修改你开发的程序. 既然如此 , 为什么不把这利人利己的事情作好呢? 一些习惯自由程序人员可能对这些规则很不适应，但是在多个开发人员共同写作的情况下，这些规则是必需的。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 较短的单词可通过去掉“元音”形成缩写； 较长的单词可取单词的头，并用括号明确表达式的操作顺序，避免使用默认优先级。 使用匈牙利表示法 Package 的命名 Package 的名字应该都是由一个小写单词组成。 package com.neu.util Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。 public class ThisAClassName{} Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头 userName , thisAClassMethod Static Final 变量的命名 static Final 变量的名字应该都大写，并且指出完整含义。 /** *DBConfig PATH **/ public static final String DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig; 参数的命名 参数的名字必须和变量的命名规范一致。