还剩2页未读,继续阅读
文本内容:
代码规范要求为保证我公司研发代码的规范性、可读性,特制定该代码规范
1、代码应遵循国际j__a代码规范
2、代码中所有switch(param){caseint break;}中case参数应该为在类开始时定义的字符串,以增加后续研发中的可读性例privatefinalintcompany=0;switchparam{casecompany:break;}不允许出现case0,case1等字样
3、在对数据库进行大量数据读取时,应采用jdbc方式读取以增快响应速度,减少内存消耗数据量超过万单位时必须采用jdbc读取数据库,且应分页读取数据库
4、方法作用必须注释,方法中传递的参数应该有注释,全局变量,局部变量都应有注释,以说明变量的意义如方__被多次调用,或应对二次__则应注明返回值例returnBooleantrue成功false失败;
5、代码中应该采用trycatch捕获异常,且应该处理常见异常
6、代码呈现页面不能出现null字样
8、代码不应出现重复定义,同一方法不能多次调用数据库,如一个方法中需要多次调用数据库则应拆分为两个或多个
9、同一方法中代码量超过50行则应进行拆分
10、代码应该采用for__t格式化
11、代码已经提交或二次__时,应注明修改时间修改人修改原因修改后提交参数的内容
12、在未进行实例化的参数判断是否为空时,应该null在前例ifnull!=param
13、在判断变量是否为空时,尽量避免采用ifelse应采用Parame==null”0”:parame;进行判断赋值
14、代码应遵循可读性原则,不能出现过于冗长的代码
15、多次在不同类中反复调用且内容相同的方法,应该写到公用代码中进行调用
16、已经失效,且不会被调用的代码应该注销、删除
17、代码在未经测试时,不要进行提交,以免造成现调用的其他类出现错误
18、项目的配置文档应该遵循规范格式,尽量增加注释
19、页面中的js脚本应该具备可读性、增加注释Js脚本的规范遵从国际js规范
20、页面中提交的必要的变量参数应该有验证
21、页面提交的信息或执行时间较长、页面上传文档时应该提示用户正在执行等字样
22、页面ext的方法复写定义应该在项目中为唯一,不得出现重复定义相同名称的方法
23、页面提交信息应该与返回提示,例执行成功,执行失败返回的提示应具有可读性,不得出现英文错误提示
24、vo,set,session,list,__p赋值应该及时清空,以免占用内存
25、如__中的数据在同一类中会被多次调用,应该定义到类的全局变量中,在同一类的不同方法中进行调用,避免重复占用内存
26、代码的业务规范应该遵从严谨的要求,在进行数据操作时,出现异常应有回滚操作
27、代码hibernate调用数据库查询时,应采用query分页,尽量避免使用subList方法
28、页面进行打印,线条应采用单线
29、页面在通常没有特殊要求的情况下,最少应支持ie浏览器
30、代码在提交时,不应出现需要测试用的log内容,前期试运行时如需跟踪则应注明,在正常运行后进行删除或注销
31、系统中反复使用的变量因进行缓存调用
32、避免在for循环中反复调用数据库进行对比
33、sql中尽量避免使用like查询
34、id一般不用int类型,用long类型
35、尽量避免拼凑sql语句,应当用占位符,预处理来发送sql语句
36、在处理多个字符串变量的时候要尽量使用StringBuffer类
37、方法名及类名称应具备一定的意义,而非随意命名
38、代码提交到cvs、svn、gita服务器时,要注明提交内容
39、不得随意覆盖其他人提交的代码,提交时应给予沟通,验证无问题、不影响系统运行、不影响系统参数传递及结果时,才可提交
40、所有代码功能都要进行详细测试,应按照《测试报告》规范格式进行测试,并注明测试用例,测试结果,问题跟踪及解决情况
41、测试人应跟踪有问题的测试情况,直到问题解决
42、方法在不同类中出现反复调用情况时,应该写到util包中,以供调用,诸如时间格式化、以时间获取编号等以上规范最终解释权归所有,特此声明。