【#第一文档网# 导语】以下是®第一文档网的小编为您整理的《代码编程规范》,欢迎阅读!
代码规范 一、命名规范 1. Package(包)的命名 Package 的名字应该都是由小写单词组成,并且以com.coship.部门.系统名 开头。 例如:package com.coship.sdp.iag.usp; package com.coship.sdp.sce.dp; 2. Class 的命名 类名是一个名词,采用大小写混合的方式,每个单词的首字母大写。 例如: public class UserService { } 3. 接口的命名 接口的大小写规则与类名相似,且以 I 字幕开头。 例如: public interface IUserService { } 4. Class 中Static Final 变量的命名 static Final 变量的名字应该都大写,并且指出完整含义。 例如: public static final String DB_CONFIG_FILE_PATH ="com.neu.etrain.dbconfig"; 5. Class 中方法的命名 方法名是一个动词或动词词组,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。一个方法不得超出50行代码。 例如: public void setUserName(); 6. 变量的命名 变量名第一个字母小写,任何中间单词的首字母大写。变量名应简短且可以顾名思义,易于记忆。避免单个字符的变量名,除非是一次性的临时变量。 例如: String userName; 二、注释规范 1. 注释要简单明了。 2. 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。 3. 3. 在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。 4. 变量、常量的注释应放在其上方相邻位置或右方,不可放在下面,且以“//”注释。 5. 类,方法的注释采用coship模板生成方法。 6. 具体要求说明: 声明性(变量定义类)一定要有注释。例如:String myName; //用户名 类定义必须生成文档(JavaDoc)注释。 方法必须生成文档(JavaDoc)注释(包括实体类的set,get 方法)。 成员变量必须生成文档(JavaDoc)注释。 方法中的逻辑部分由程序编写人根据复杂情况自行书写。 三、基础代码引用(sdp-infrastructure) 1. 数据库dao封装、utils工具类 引用 iag_core模块代码。 2. 权限控制 引用 iag_permission 模块代码。 3. 操作日志 引用 iag_log模块代码。 四、日志组件使用规范(Debug日志工具) 1. 2. 3. 4. log.debug()是放在代码行中间,用来调试时输出使用,永久保留,不用删除。 log.error()是放在try{}catch(){}中catch部分里的用来输出error 异常信息使用的。 代码中不得出现 System.out.println()打印信息。 日志输出统一使用 sdp-core模块下的com.coship.sdp.utils.Debug 工具类,不再引用Log4j日志组件。调用时,使用带有参数 String module 的方法,即指定输出日志的模块名(类名)。 五、测试用例规范(DbUnitUtils工具) 1. 单元测试类统一继承 com.coship.sdp.test.utils. SpringTestCase.java 类。 2. 单元测试数据库统一连接10.10.91.115:3306/系统名_test 数据库。 例如: USP 10.10.91.115:3306/uspdb_test DP 10.10.91.115:3306/dpdb_test 3. 作单元测试时,统一使用sdp-core模块下的com.coship.sdp.test.utils. DbUnitUtils工具类,初始化测试数据。 4. 务必为每个service类的所有方法编写单元测试用例,且类名以UT(UnitTest)结尾。 例如: UserServiceUT.java 5. 为action类编写集成测试用例,类名以IT(IntegratTest)结尾。 例如: UserActionIT.java 六、语言国际化 1. 国际化资源文件统一放在各个模块下的src\main\resources\com\coship\sdp\*\message 下(其中*为模块名称),文件名以MessagesResources开头。 例如: MessagesResources.properties、MessagesResources_zh_CN.properties 七、业务异常 1. Sevice层统一抛出 ServiceException 业务异常(com.coship.sdp.exception. ServiceException.java)。 八、前台JS 1. 前台JS校验统一使用formValid.js、fv_onBlur.js、regExps.js 校验框架。 2. 前台JS国际化使用language.js以及自定义国际化语言JS文件,名称统一以XXX—_MessageResource_XXX.js命名。 例如: 中文 :MessageResource_zh-cn.js JS文件定义如下: var Lang = { hello : "你好世界!", hi : "你好世界!" } 英文: MessageResource_en-us.js; JS文件定义如下: var Lang = { hello : " Hello World!", hi : " Hello World!" } 本文来源:https://www.dywdw.cn/50b6c22fb91aa8114431b90d6c85ec3a87c28bd6.html