规范_JAVA编码规范_JAVA编码.doc

文档状态： 文档编号： 规范_JAVA编码 [ ] Draft [√] Released [ ] Modifing 编 撰： 王英杰 编撰日期： 2006-5-21 必威体育官网网址级别： 机密 文档版本： 2.0.0 JAVA编码规范 铁道科学研究院电子计算技术研究所 北京经纬信息技术公司 版 本 历 史 日期 版本 说明 作者 2006-04-08 0.0.1 初稿 王英杰 2006-04-30 1.0.0 咨询公司审计通过，正式发布 EPG 2006-05-21 2.0.0 增加系统集成项目过程 佘振国 目 录 1 目的 4 2 范围 4 3 规范内容 4 3.1 命名规范 4 3.2 文件样式规范 6 3.3 程序编写规范 8  JAVA编码规范 目的 为了保证所每个项目组编写出的程序都符合相同的规范保证一致性、统一性entity Manager)必须使用实体名称的英文单词或拼音+Manager的结构 仅返回结果集的用于数据库查询的servlet使用dso + 英文单词或拼音 + Servlet 用于初始化服务器或数据库或者在服务器启动时执行的servlet使用init + 英文单词或拼音 + Servlet 返回业务逻辑的servlet使用logic + 英文单词或拼音 + Servlet 类变量和常量的命名 类变量和常量的命名必须使用小写字母构成的英文单词或拼音 多个单词或拼音的构成命名，第一个单词(可缩写)全部小写，第二个单词(可缩写)的首字母必须大写，其余字母小写 静态变量的命名必须使用static标示 必须使用protect、public、private标示类变量和常量；缺省可省略的public标示符也必须注明，不能省略 常量命名全部使用大写字母构成的英文单词和拼音 同名类变量或常量使用变量名或者常量命的英文单词或拼音+下划线+阿拉伯数字构成用于区分 参数命名 参数的命名必须使用小写字母构成的英文单词或拼音 多个单词或拼音的构成命名，第一个单词(可缩写)全部小写，第二个单词(可缩写)的首字母必须大写，其余字母小写 同名参数的英文单词或拼音+下划线+阿拉伯数字构成用于区分 参数命名必须能够标示其含义 数组命名 数组必须使用小写字母构成的英文单词或拼音+[ ] 多个单词或拼音的构成命名，第一个单词(可缩写)全部小写，第二个单词(可缩写)的首字母必须大写，其余字母小写 数组总是使用：String arrary[ ] 命名，而不是 String[] array 数组命名必须能够标示其含义 方法的命名 方法必须使用小写字母构成的英文单词或拼音 多个单词或拼音的构成命名，第一个单词(可缩写)全部小写，第二个单词(可缩写)的首字母必须大写，其余字母小写 方法的命名必须能够标示其含义 静态方法必须使用static标示 必须使用protect、public、private标示方法；缺省可省略的public标示符也必须注明，不能省略 其它相关文件的命名 (jsp文件、javaScript文件、图片文件、css文件、xml文件、DTD文件、xsl文件、属性配置文件、HTML文件) 文件的命名必须使用小写字母构成的英文单词或拼音 多个单词或拼音的构成命名，第一个单词(可缩写)全部小写，第二个单词(可缩写)的首字母必须大写，其余字母小写 文件的命名必须能够标示其含义 属性配置文件名后缀使用 *.property jsp文件的 HTML相关对象的命名 命名必须使用小写字母构成的英文单词或拼音 多个单词或拼音的构成命名，第一个单词(可缩写)全部小写，第二个单词(可缩写)的首字母必须大写，其余字母小写 命名必须能够标示其含义 field： fld + 单词或拼音 textArea：ta + 单词或拼音 checkbox: cb + 单词或拼音 radioBox: rb + + 单词或拼音 image : img + 单词或拼音 link : lk + 单词或拼音 hiddenFileld : hiddenFld + 单词或拼音 pullDownSelection: ps + 单词或拼音 horizonLine: hl + 单词或拼音 button : btn + 单词或拼音 imageButton : imgBtn + 单词或拼音 banner : ban + 单词或拼音 3.2 文件样式规范 版权信息 /** *Copyright 2003 电子计算技术研究所 *All Right Reserved *Author ：作者姓名 *编码日期格式：YYYY-MM-DD */ package/import package行要