Java软件编程规范说明书.doc

《Java软件编程规范说明书.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、山海经纬研发中心Java软件编程规范说明书文档编号SHJW_F_YFZX_004版本号V1.0总页数23页编写曹五丰审核王生批准李强生效日期2008-06北京山海经纬信息技术有限公司二零零八年六月修改记录版本号变更控制报告编号更改条款及内容更改人审批人更改日期1.0　文件审核版本发布曹五丰王生　　　　　　　　　　　　目录1引言52编码规范52.1Java编码规范52.1.1命名规范5Package的命名5Class的命名5Class变量的命名6StaticFinal变量的命名6参数的命名6数组的命名6方法的参数62.1.2变量定义规范62.1.3代码编写格式72.1.4

2、注释规范82.1.5函数、过程92.1.6编程技巧10byte数组转换到characters10Utility类10初始化10枚举类型102.1.7程序编写规范11exit()11异常11垃圾收集11Clone12final类12访问类的成员变量122.1.8排版规范132.1.9Java文件格式13版权信息13Package/Imports14Class14ClassFields14存取方法15构造函数15类方法16toString方法16main方法172.1.10可读性172.1.11性能17不必要的对象构造17使用StringBuffer对象17避免太多的使用s

3、ynchronized关键字182.1.12可移植性18换行18PrintStream182.1.13代码测试、维护182.1.14质量保证192.1.15代码编译202.2Jsp编码规范202.3Struts编码规范212.3.1Action,Form,Bean命名规则21Action：命名以Action结尾,21Form：命名以Form结尾,22Bean:命名以Bean结尾，222.3.2struts-config.xml的定义规则22form属性定义规则22action属性定义规则221引言·代码规范相当重要.代码规范提高软件代码的可读性,使得开发人员快速和彻底的

4、理解新代码.·好的代码风格不仅会提高可读性,而且会使代码更健壮,更为重要的是在修改时不容易出错.·在现代软件开发中,维护工作会占用80%的时间,而且开发者和维护者通常不是同一个程序员.这意味着你经常要阅读和修改别人开发的程序,别人也同样可能需要阅读和修改你开发的程序.既然如此,为什么不把这利人利己的事情作好呢?一些习惯自由程序人员可能对这些规则很不适应，但是在多个开发人员共同写作的情况下，这些规则是必需的。2编码规范2.1Java编码规范2.1.1命名规范n定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这

5、些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）n较短的单词可通过去掉“元音”形成缩写；n较长的单词可取单词的头，并用括号明确表达式的操作顺序，避免使用默认优先级。n使用匈牙利表示法Package的命名Package的名字应该都是由一个小写单词组成。packagecom.neu.utilClass的命名Class的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。publicclassThisAClassName{}Class变量的命名变量的名字必须用一个小写字母开头。后面的单词用大

6、写字母开头userName,thisAClassMethodStaticFinal变量的命名staticFinal变量的名字应该都大写，并且指出完整含义。/***DBConfigPATH**/publicstaticfinalStringDB_CONFIG_FILE_PATH="com.neu.etrain.dbconfig";参数的命名参数的名字必须和变量的命名规范一致。数组的命名数组应该总是用下面的方式来命名：byte[]buffer;而不是：bytebuffer[];方法的参数使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：SetCounter(

7、intsize){this.size=size;}2.1.2变量定义规范　1.去掉没必要的公共变量。　　2.构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共　　　变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。　　3.仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。　　4.明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。　　5.当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生 　　6.防止局部变量与公共变量同名。　　7.仔细设计结构中元素的布