3.1编程规范_JAVA.docVIP

Java编码规范 代码规范小组 2011-04-30 目录 1. 摘要（Abstract） 3 2. 编码规范 3 2.1. 命名规范 3 2.1.1. 包的命名 3 2.1.2. 类、接口命名 3 2.1.3. 方法的命名 3 2.1.4. 域的命名 3 2.1.5. 局部变量的命名 4 2.1.6. 参数的命名 4 2.1.7. 数组的命名 4 2.1.8. 方法的参数 4 2.2. 注释规范 4 2.2.1. 包（Package） 4 2.2.2. 类（Class） 5 2.2.3. 方法（Method） 5 2.2.4. 变量(Variable) 6 2.2.5. 编码（Code） 6 2.2.6. 版本（Version） 6 2.3. 代码编写格式 6 2.3.1. import 6 2.3.2. 括号 7 2.3.3. exit() 7 2.3.4. final 7 2.3.5. static 7 2.3.6. 异常处理 8 2.3.7. 垃圾收集 8 2.3.8. Clone 9 2.3.9. 访问类的成员变量 10 2.3.10. 调试信息 10 2.3.11. 建议遵循的一些原则 10 2.4. 性能调整 11 2.4.1. String与StringBuffer 11 2.4.2. 批处理 11 2.4.3. DMO数据库查询中变量的声明 12 2.5. NC系统特定代码规范 12 2.5.1. 国际化规范 12 2.5.2. Sql写法规范 12 2.5.3. Hashtable使用（BS-UI） 13 2.5.4. BO、DMO中禁止声明变量 13 2.5.5. 组件化 13 3. 相关文档 13 摘要（Abstract） 任何一门语言都是用来交流的，都有自己的一套书写规范，Java 也不例外。 好的编码规范可以让你的程序更专业，更容易被别人理解，更好维护，更高效。在软件团队开发的情况下，这些规则是必需的。这不仅仅是为了开发效率来考虑，而且也是为了后期维护考虑。 编码规范 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 命名程序对象的总体规则为: 使用混合大小写的英文单词或英文缩写描述变量、类名、方法等。并且尽量使用该领域习惯的术语；英文缩写，必须统一定义，统一使用； 避免超过15个字母的命名； 避免出现字母完全相同，仅大小写不同的命名； 为了保证命名的统一规范，建立一本常用命名词典，程序员要严格按照命名词典对变量进行命名。 2.1.0 项目的命名 项目的组织上可以粗粒度，减少项目的数量,项目的命名要能反映该项目下包/类的业务含义.产品的对外接口应单独组织到一个项目中，该项目命名以OUT结尾. 建议的项目命名方式为NC-产品系列-模块中文名称-项目类型.比如:NC-SCM-采购管理-INTERFACE 具体到一个产品模块:建议包含4个项目,其项目类型分别为: 产品主体项目类型:以MAIN结尾,表示该项目存放产品主要代码; 产品接口项目类型:以INTERFACE结尾,表示该项目为产品对外提供的接口; 产品公共项目类型:以PUB结尾,表示该项目为该产品内部多个包引用的公共服务; 产品测试项目类型:以TEST结尾,表示该项目为该产品的测试代码. 包的命名 由小写字母和少量数字组成，包名统一用代表模块贴切含义的英文单词或缩写，字母一律小写，每级包名的最大长度不能超过8位。 包名第一级为nc 包名的第二级按层次结构规范划分 二级包名主要便于部署，由ui、bs、vo构成，ui包含界面类和界面控制类，部署在客户端；bs包含业务组件、数据查询和数据管理对象，部署在服务器端；vo为数值对象，同时部署在客户端和服务器端 安装程序全部在bs包下面 中间件中，部署在客户端的代码放在ui包中 系统管理和中间件在服务器端的界面部分也放在bs包中 包名的第三级按产品划分 三级包名主要便于按产品安装，必须按照产品命名规范 包名的第四级按如下规定划分 ui按《产品用例清单》中的功能子包划分或按照业务对象划分. 类、接口命名 用第一个字母大写的英文正常语序准确描述类的含义。 如：Employee MainFrame 业务逻辑代码类以BO结尾，如：GeneralLedgerBO 数值对象类以VO结尾，如：EmployeeVO 数据管理对象类以DMO结尾，如：EmployeeDMO 非参照对话框类以Dlg结尾，如：EditEmployeeDlg 参照对话框类以Ref结尾，如：WorkCenterRef 面板类以Panel结尾，如：GeneralLedger