JAVA编码规范和指南培训(新改).ppt

《JAVA编码规范和指南培训(新改).ppt》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、税友软件集团Java编码规范和指南培训纳税事业部/王伟20091125课程目标使开发人员认识到编码规范和指南存在的意义对公司的《开发编码规范(JAVA)》、《JAVA编码指南》、《JavaScript编码规范》和《J2EE项目开发命名标准》等文档做一简介，使开发人员对此有个总体印象，知道在以后的工作中需要遵守这些规范通过对公司编码规范和编码指南的介绍，使得开发人员了解到其侧重点WWW.JDLSSOFT.COM.CNPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代码检查工具介绍及使用WWW.JDLSSOFT.COM.CN一、

2、编码规范的目的宗旨：为了开发小组能够在编码过程中遵循一致的风格，使得代码阅读者能够非常清晰的各个成员编写的代码，使得维护人员能够很好的继承前辈的代码，制定编码规范；编码工程师：负责按编码规范实施编码工作。代码审核人：负责按编码规范审核代码。WWW.JDLSSOFT.COM.CN二、编码指南的目的宗旨：为了提高团队编程的质量、协同性、规范性，需要对项目的编码过程作出指导和约束；同时也作为概要设计、详细设计的补充，及测试的依据。每个项目都需要结合项目实际情况制定相应的编码指南项目组织者：在编码开始前根据公司编码指南模板，对其进行裁剪和细化，于项目编码前公布，并组织对全体编码人员、测试人员进行培训，

3、作为项目级规范必须遵守，同时指定本项目各种规定的负责人、检查人。编码人员：深入理解本项目编码指南中所要求的一些约束、规定，如是编码指南中某个方面的负责人，则还需要切实检查并督促其他编码人员遵循这些规定。WWW.JDLSSOFT.COM.CN三、编码规范与编码指南编码规范是一组相对静态的规范，而项目指南是项目组内相对动态的；编码规范是针对编码的成果，而编码指南是针对项目编码的过程；编码指南是贯彻编码规范的一种较好的方法，项目组内没有制定或没有很好的执行编码指南，通常会造成代码成果没有什么规范性编码指南除了对项目内编码规范作出指南之外，还要关注很多方面，比如开发框架、命名约定等内容WWW.JDLS

4、SOFT.COM.CNPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代码检查工具介绍及使用WWW.JDLSSOFT.COM.CNJAVA编码规范包括的几个方面源代码格式和文件样式版权信息、类注释、javadoc、缩进、页宽等命名规范包名、类名、方法名、变量名等的通用规范程序编写规范clone、final、垃圾收集等一些编程约束和技巧一些经验和建议，时至今日，依然有价值WWW.JDLSSOFT.COM.CNPPT概要制定编码规范和指南的意义JAVA编码规范包括的几个方面JAVA编码指南包括的几个方面JAVA编码规范相关文档代

5、码检查工具介绍及使用WWW.JDLSSOFT.COM.CNJAVA编码指南包括的几个方面开发环境、技术框架、工程结构及命名规定开发方面规范和约束的关键要素编码过程负责人分工WWW.JDLSSOFT.COM.CN一、开发环境、工程结构及命名规定项目开发架构开发架构、使用框架（交大龙山架构、扩展包、Struts等等）、开发流程等项目开发环境WEB层目录结构、代码包结构目录、配置文件命名等例global、images、scripts、pages/模块名等cn.com.jdlssoft.系统名.web.模块名.actionsWEB-INF/config/目录EJB层代码包结构目录、配置文件目录编译和打

6、包结构、打包脚本WWW.JDLSSOFT.COM.CNJAVA编码指南包括的几个方面开发环境、技术框架、工程结构及命名规定开发方面规范和约束的关键要素编码过程负责人分工WWW.JDLSSOFT.COM.CN二、开发方面规范和约束的关键要素界面约束公共方法与函数常量类提示信息日志注释WWW.JDLSSOFT.COM.CN2.1、界面编码约束页面元素使用规则文本输入框、日期输入框、金额、小数、身份证页面操作约定新增、删除、修改、查询、进度条、返回、退出页面特殊字符处理URLEncoder.encodeConvertType.filterWWW.JDLSSOFT.COM.CN2.2、公共方法与函数架

7、构级的工具类SysUtil、StringUtil、FileUtil等扩展包中BaseCode页面上进行代码/名称转换、下拉框选择项目自定义的公共方法项目级、模块级JS公共函数及工具组件WWW.JDLSSOFT.COM.CN2.3、常量类***Constants类中自定义的常量对象公共的常量类模块级的常量类模块目录下层次级的常量类层次目录下项目级的常量类common目录下WWW.JDLSSOFT.C