代码规范
- 代码因遵循国际java代码规范
- 方法的作用必须注释,方法中传递的参数应该有注释,全局变量、局部变量都应该有注释,以说明变量的意义
- 代码中应采用try catch 捕获异常,且应该处理常见异常
- 代码不应出现重复定义
- 同一方法代码量不超过50行则应进行拆分
- 代码应遵循可读性原则,不能出现过于冗长的代码
- 已经失效,且不会被调用的代码应该注销或删除
- 代码应该采用format格式化
- 代码在未经测试时,不要进行提交,以免造成调用的其他类出现错误
- 项目的配置文档应该遵循规范格式,尽量增加注释
- 页面中提交的必要的变量参数应该有验证
- 页面提交的信息或执行时间过长时,页面上传文档时应该提示用户“正在执行”等样式
- 页面提交应该有返回提示,如执行成功、执行失败。返回提示应具有可读性,不得出现英文粗欧文提示
- 代码的业务规范应遵从严谨的原则,在进行数据操作时,出现异常应有回滚操作
- 如集合中的数据在一个类中对被多次调用,应该定义到类的全局变量中,在同一类的不同方法中进行调用,避免重复占用内存
- 控制台应可以进行打印,线条采用双线
- 代码在提交时,不应出现测试用的log内容,前期试运行时如需运行时如需给你总则应注明,在正常云翔后进行删除或注销
- 避免在for循环中反复带哦用数据库进行对比
- 方法名及类名称应具备一定意义,而非随意命名
- 方法在不同的类中出现反复调用情况时,应该写到tools包中,一共调用,诸如时间格式化、以时间获取编码等
- 不得随意覆盖其他人提交的代码,提交时应给予沟通,验证无问题、不影响系统运行、不影响系统参数传递及结果时,才可提交。
- 所有代码功能都要进行详细测试,并注明测试例、测试结果、问题跟踪及解决情况