《WEB开发规范》由会员分享,可在线阅读,更多相关《WEB开发规范(7页珍藏版)》请在金锄头文库上搜索。
1、WEB 开发规范开发规范Java 规范:规范:1.命名规则英文名称,禁止采用拼音字母和阿拉伯数字文件命名:首字母大写方法命名:首字母小写参数命名:首字母小写,首字母表示类型,输入型参数前扩展字母a2.代码风格递次缩进四个空格3.文件存放路径:com.eastelsoft.项目名.功能分类.*4.文件规范a.注释方法前的注释规则/* #* param asParame #* return 无返回值*/ public void XXXX(String asParame)throws Exception方法中的注释规则/#b.连接释放针对 ResultSet,Statement,和 Prepared
2、Statementtry/创建。 。 。 for() /释放 /创建 finally /释放 释放顺序:ResultSet,Statement,和 PreparedStatement,Connectionc.日志功能性 javabean,只允许调试阶段出现 System.out.println不建议进行堆栈的打印,对堆栈可采用外抛异常方式,在调试阶段可在本地配置 web.xml 中 loggerType 属性配置 stack 进行堆栈的打印日志打印采用 log4j 方式:import eet.evar.tool.Logger;Logger.debugLog(“#“); Logger.infoL
3、og(“#“); Logger.warnLog(“#“); Logger.errorLog(“#“); Logger.error(“#“,ex);界面上异常发生后给用户提示:import eet.evar.base.ExceptionProto; throw new ExceptionProto (“#“);d.数据库兼容性sql 语法:字段,表名大小写以表结构设计为准兼容性语法配置到 SQl 配置文件中eet.evarvno.jb.manager.queryParam1.java eet.evarvno.jb.manager.queryParam2.java eet.evarvno.jb.m
4、anager.queryParam3.java日期字段:queryParam1.sParam0如有提交数据库操作注意表结构字段类型e.类主体方法的瘦身类主体方法尽可能简单清晰,对于复杂方法多写注释和子方法f.大括号使用方式public void XXXX(String asParame)throws Exception为了代码统一,禁止以下使用方式 public void XXXX(String asParame)throws Exception Jsp 规范:规范:1.命名规则英文名称,禁止采用拼音字母和阿拉伯数字文件命名:全部小写,中间以下划线“_“分隔表单命名:同时命名 id 和 nam
5、e,提交数据的表单字母全部大写2.代码风格注意缩进,保持整体风格3.文件存放路径:项目.功能分类.*4.文件规范a.注意点:不建议直接在 jsp 中写 sql 语法尽可能少的出现 java 代码尽可能少的出现 javascript 代码不要出现无关语句(针对使用了 form 标签后的拷贝)不要在 title 中出现关键信息(如项目名等,推荐统一采用 system)Javascript 规范:规范:1.命名规则英文名称,禁止采用拼音字母和阿拉伯数字文件命名:文件名同 jsp 文件,一一对应方法名:全部小写,中间以下划线“_“分隔,禁止阿拉伯数字2.代码风格递次缩进四个空格3.文件存放路径:项目.功能分类.js.*4.文件规范a.注意点:推荐使用 obj,sValue 等常用参数,推荐重复使用推荐使用 document.getElementById,少用 document.*eval 最容易被滥用,避免使用。b.大括号使用方式function xxx_click()if (condition) statements; else if (condition) statements; else statements; 为了代码统一,禁止以下使用方式function xxx_click() c.setTimeout,setInterval 传递参数用法