文档介绍:项目名称:项目经理:文档版本编号:项目阶段:文档版本日期:质量复审方法:起草人:起草日期:复审人:复审日期:版本记录版本编号版本日期修改者说明文件名目录1 引言 32 Java开发规范 包名 一般类 抽象类 方法定义 静态方法 局部变量 注释 5类注释规范 5类属性注释规范 5方法注释规范 5代码间注释规范 6注释内容要求 文件日志 操作日志 异常处理 单元测试 代码复用性 代码扩展性 性能优化 Java代码格式规范 83 页面端编码规范 JavaScript注释规范 JavaScript变量命名 JavaScript代码复用 页面规范 9引言为了使P17系统开发工作在规范中进行,根据本项目具体情况,约定开发规范,其中包括:后台Java、前台JavaScript以及页面展示的Freemarker,以便增加小组中代码可读性。.。名字可以有两个或三个单词组成,但通常不应多于三个。使用名词或名词短语命名类。少用缩写。不要使用下划线字符(_)。例:lassCallSummaryService抽象类和类命名规范相同,唯一区别是接口在名字前加上“Abstract”lassAbstractServiceRequest方法定义使用动词或动词短语命名方法。第一个动词小写,后面单词首字母大写,用操作名称开头operationName一些基本方法命名:set 设置get 获得is 是否sum 汇总execute 执行do 做querydelXXupdateaddExamples:panyName(panyName);方法中的参数命名采用Camelcasing,除了首字母小写外,其他所有单词第一个字母大写。静态方法静态方法每个单词首字母大写,其余小写。Examples:publicstaticvoidstartConnect(intintConnectID);局部变量局部变量名称=变量的前缀+代表变量含意的英文单词或单词缩写。变量前缀表示其类型,可参考如下:str----------string;vct----------Vector;flt----------float;int----------int;hat----------HashTable;等等。Examples:StringstrMAWBName;intintMAWBNum;即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如i或j。不要使用原义数字或原义字符串,如fori=1to7。而是使用命名常数,如fori=1toNUM_DAYS_IN_WEEK以便于维护和理解。注释注释规范包括:类注释规范、类的属性、方法注释规范、代码间注释规范类注释规范类注释放在每个类定义的前面,格式如下:/***<对类的描述>*****@author$Author:$*创建时间格式YYYY-MM-DD **/请在Eclipse里面设置模板,Windows菜单->Preference->Java->CodeStyle->CodeTempl