javaweb开发规范
《Java Web应用开发I》课程标准

态度性评价
根据作业完成情况,课堂回答问题、实践完成情况,由教师综合评定学习态度的得分;
根据上课考勤情况,由教师和学生干部评定纪律得分。
20%
知识性评价
由教师评定成绩。
40%
技能型评价
根据学生实践操作情况,由学生自评、组内他人评价和教师评价相结合评定成绩;
根据完成的时间、功能的完善情况、是否有创新,由组长和教师评价相结合的方式评定成绩。
5.能应用JDBC数据库访问技术编写基于数据库的Web程序,以实现信息的持久化存储;
6.能应用JSP 模式1(JSP+JavaBean)开发方法优化JSP程序;
7.能应用JSP 模式2(JSP+JavaBean+Servlet)开发方法优化⑧能应用JSP模式2+DAO模型开发方法优化JSP程序;
8.能对程序进行调试;
(3)教师准备:教材、教案及课件、素材。
10.考核方式建议
该课程的考核改变单一的终结性评价方式,采用态度性考核、知识性考核、技能性考核相结合,与创新性评价附件分一并合计计算的形成性考核方式。其中态度性评价占20%,知识性评价占40%,技能型评价占40%,另外对于学生的创新性评价,总分不得超过10分,主要考核学生运用数据结构技术的掌握情况;理论部分考核学生对教学中各知识点综合应用的掌握情况。灵活多样的考核方式可以全面考核学生的学习效果。课程考核方式如表1下所示。
4.熟练掌握JSP中内置对象的特点及用法;
5.熟练掌握JDBC访问数据库技术;
6.熟练掌握JavaBean技术;
7.掌握Servlet技术;
8.掌握JavaWeb开发模式。
能力目标
1.能搭建典型的JSP开发环境;
WEB前端开发代码使用要求规范

WEB前端开发代码使用要求规范1.编码规范- 使用标准的HTML、CSS和JavaScript语法。
-使用缩进和空格来提高代码的可读性。
-使用注释来解释代码的目的和功能。
2.文件和目录结构规范-使用有意义的文件和目录命名,方便其他开发人员寻找代码。
-在项目中使用统一的目录结构,例如将HTML文件存放在一个文件夹中,将样式文件存放在另一个文件夹中,以此类推。
3.HTML规范- 避免在HTML中直接写入样式和脚本代码,应将样式和脚本代码分离到对应的CSS和JavaScript文件中。
4.CSS规范-使用适当的选择器,避免过多的嵌套。
-避免使用内联样式,应将样式写在CSS文件中,以提高可维护性。
- 使用合适的样式命名规则,例如使用BEM(Block-Element-Modifier)命名规则,或其他约定俗成的命名规则。
5. JavaScript规范-使用合适的变量和函数命名,提高代码的可读性。
-避免使用全局变量,应将变量和函数封装在模块中。
- 使用严格模式(`use strict`),避免不规范的语法和行为。
- 避免使用`eval`和`with`等不安全的代码。
-在循环中使用合适的终止条件,避免死循环。
6.代码结构规范-代码应具有良好的组织结构,例如使用模块化的方式来组织代码。
-尽量遵循单一职责原则,每个函数和类应该只负责一件事情。
-提取重复的代码块,封装成函数或类,以提高代码的复用性。
-不要写过长的函数或类,应该根据需要进行拆分和重构。
7.注释规范-使用注释来解释代码的目的和功能,特别是代码的复杂部分。
-注释应该清晰、简洁,方便其他开发人员理解代码。
-避免使用无用的注释,注释应该随着代码的变化而更新。
总之,遵守WEB前端开发代码使用要求规范能够提高代码的质量和开发效率,减少错误和维护成本。
同时,还能提高团队合作的效率,方便其他开发人员理解和修改代码。
因此,在进行WEB前端开发时应该积极遵守和推崇相关规范。
(最新)开发编码规范文档

1Web开发规范概述Web开发规范是针对Web系统差别于传统的软件开发,为规范前台Web页面风格以及后台Java程序编码而编写的,为了保证开发代码风格的一致性、规范性和可读性,减少后期程序维护的工作量,要求项目组各成员在进行设计的过程中必需遵守执行,如果对本规范有异议或者需要在规范中增加新的条目,请尽早提出,以利于规范的更改以及相关代码的及时更改。
定义本规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。
本规范并不是一定要绝对遵守,但是一定要让程序文档有良好的可读性及统一的规则,具体项目可以根据项目的实际情况对本规范进行剪裁和补充,生成项目组成员实际遵守的开发规范,以达到适应不同开发工具不同开发模式的项目。
2Web页面开发规范2.1页面风格规范2.1.1页面统一规范页面风格必须保持一致,包括页面的前景色,背景色等内容,页面内容摆放遵循统一规则,对于页面风格尽可能使用CSS模式文件。
例如对于所有页面都要有“关闭”“返回”“帮助”链接:统一在页面左上角,顺序为“关闭”、“返回”、“帮助”。
处理规则:点击“关闭”链接,如果本页面是弹出的,则关闭本页面,否则返回到“任务列表”页面;点击“返回”链接,返回到上一个页面;点击“帮助”链接,弹出本页面的操作说明及下一步如何操作。
2.1.2操作按钮规范规范所有的按钮的展示属性,包括大小、尺寸及图标、tooltips等。
2.1.3录入项目规定所有界面的必选项目必须添加红色的“*”进行标注,并且在保存的过程中执行相应的判断并以提示信息的形式进行提示。
2.1.4信息框规定,提示信息,如必须项目确认信息,提示用户并需要得到用户的认可警告信息,系统处理失败需要提示用户的信息由客户引起的失败由应用程序引起的失败:删除必须以确认信息的形式进行说明成功保存处理后都必须以提示信息的方式进行提示失败处理必须以警告信息的形式进行提示2.2HTML编码规范●必须为title赋值并且在可能的情况下和页面内容中的标题一致;如果要为HTML文件加图片,图片的尺寸不能超过250*250,图片的大小不能超过30K,必须保证一个网页总长度限制在50k;必须定义每页的background color,即使background color为白色,也必须把它定义在<body>标签里;●用级联格式页(即CSS)定义显示方面的内容,例如:字体、边框等等;用Dreamweaver或其他专业工具作为HTML的开发工具;设计以800*600作为显示器的标准;●用IE4.0和Netscape4.0作为标准测试浏览器;尽量不用Frame;尽量避免使用动态HTML,例如:层……●使用封闭式标签(balanced tags)类似于<html></html>,<head></head>以及<body></body>这类标签,一页中只能用一次,以避免在Netscape浏览器里出现刷新问题,在被包含文件中,不允许用以上标签;源代码要格式良好(这一点尤其重要),要像其他程序源码一样有缩进;不允许使用中文全角空格,必须使用“ ”。
javaweb应用程序的规范目录结构

Java Web应用程序的规范目录结构一、Java Web应用程序必须使用规范的目录结构:–应用程序根目录–|--WEB-INF目录:必须目录–|--web.xml:Web应用部署描述文件,必须目录–|--classes目录:存放字节码文件–|--lib目录:存放第三方类库文件–|--TLD文件:标签库描述文件–|--其他静态文件:HTML、CSS、JavaScript、图片等二、开发Java Web应用程序的大致流程–设计目录结构:根据具体业务需要,遵照规范的目录结构设计好Web应用程序的目录结构。
–编写Web应用程序代码:编写业务逻辑所需的Java代码。
–编写部署描述文件:把Servlet、初始化参数等定义到部署描述文件web.xml中。
–编译代码:把编写好的Java源代码编译成字节码。
–将Web应用程序打包:把整个Web应用程序打成War包,以方便部署。
–部署Web应用程序:把打好的War包部署到Web服务器上。
–执行Web应用程序:启动Web服务器,利用客户端浏览器进行访问测试。
注意:在具体的开发过程中,一般都会使用IDE工具,使用IDE工具进行Web 应用程序开发时,只需要开发人员完成前三个步骤,其他步骤IDE工具可以自动完成。
三、Servlet是用Java编写的Server端程序,它与协议和平台无关。
Servlet运行于Java服务器中。
四、Java Servlet可以动态地扩展服务器的能力,并采用请求-响应模式提供Web 服务。
五、Servlet是使用Java Servlet应用程序设计接口及相关类和方法的Java程序。
它在Web服务器上或应用服务器上运行并扩展了该服务器的能力。
Servlet装入Web服务器并在Web服务器内执行。
六、Servlet是以Java技术为基础的服务器端应用程序组件,Servlet的客户端可以提出七、请求并获得该请求的响应,它可以是任何Java程序、浏览器或任何设备。
javaweb应用开发课程标准

课程标准所属系部:信息工程系课程名称:Java Web应用开发课程性质:专业必修课课程学时:96适用专业:云计算技术与应用Java Web应用开发课程标准1、课程概述课程定位Java Web应用开发是云计算技术与应用专业的核心课程之一,是该专业的专业必修课;通过本课程的学习,使学生具备Java Web应用开发相关知识、良好的编程习惯和应用软件开发的能力,能胜任基于Java Web开发等工作任务;Java的J2EE体系中,JSP/Servlct/JavaBcan占据了非常重要的位置,不仅成为web项目开发的利器,而且也是人们接触和使用J2EE的一个基础;通过详实的内容和丰富的案例,引领学生学习JSP/Scrvlet/JavaBcan的开发体系,以及这套技术在项目开发中的实际应用;同时,通过教学过程中的实际开发过程的规范要求,培养学生分析和解决实际问题的能力,强化学生的职业道德意识、职业素质养意识和创新意识,为学生以后从事更专业化的软件开发工作奠定基础;Java Web程序开发入门是面向计算机相关专业的一门专业Java Web入门课程,涉及XML 基础、Tomcat服务器、HTTP协议、Servlet技术以及JSP技术等内容,通过本课程的学习,学生能够了解XML的语法及其约束的定义,能够掌握JSP和Servlet技术并开发简单的Java Web项目、使用Tomcat服务器发布和运行Java Web项目;前导课程有Java程序设计、数据库技术基础,后续课程有J2EE项目开发、Java Web应用开发实训、毕业实习等;课程设计思路本课程标准以“开发”、“应用”为原则,彻底打破原来学科课程链路模式,根据基于工作过程专业建设模式,以能力为本位,构建以实际工作情境为单位的课程体系;课程内容的选取按照软件开发市场、软件企业、行业对Web开发程序员的需求情况,确定了“初级Web程序员”的职业岗位培养目标;在教学实施过程中基于实际工作的教学模式、通过各种各样的教学方法和教学手段,培养Web 程序员应具备的能力;每个项目的学习都是围绕职业能力的形成组织课程内容,以真实项目为核心整合Web程序员的所需的知识、技能和态度;实践中创设职业情境,围绕着软件企业、软件行业中的实际项目而展开的,学生通过各个环节的技能训练,感受职业环境,实现编程技能的逐步提升;本课程课时为96学时;本课程在教学过程中,倡导自主学习,启发学生对设定问题积极思考、分析,鼓励多种思维方式并将其表达出来,尊重个体差异;采用项目教学法进行教学,每个项目的成绩采取自评、互评、教师综合评价相结合的方式能激励学生的学习兴趣和自主学习能力的发展;教师在给学生评价成绩时应尽量以学习过程中的评价为主,注重培养和激发学生的学习积极性和自信心;最后期末的成绩评价应注重检测学生的知识应用能力;学生的最终课程成绩应由平时的各次项目成绩和期末的评定成绩按一定比例构成,在把握比例构成时要有利于促进学生的知识应用能力;建立以过程培养促进个体发展,以学生可持续发展能力评价教学过程的双向促进机制,以激发兴趣、展现个性、发展心智和提高素质为基本理念;本门课程主要涉及XML基础、Tomcat服务器、HTTP协议、Servlet技术以及JSP技术等内容,通过本课程的学习,学生能够了解XML的语法及其约束的定义,能够掌握JSP和Servlet技术并开发简单的Java Web项目、使用Tomcat服务器发布和运行Java Web项目;2、课程目标根据计算机软件技术专业的整体培养目标,该课程的目标定位为:通过本课程的学习使学生具备Java Web应用开发相关知识、良好的编程习惯和应用软件开发的能力,能胜任Java Web相关开发工作任务;培养学生规范编码和良好的程序设计风格;培养学生面向对象编程的思维和提高逻辑思维能力;培养学生发现问题、分析问题、解决问题的能力;培养良好的职业素质;培养团队协作和和谐的沟通能力;并为学生以后从事更专业化的软件开发工作或者学习后续课程打下良好的基础;能力目标1具备使用HTML,CSS,JavaScript等技术编写网站前台静态页面的能力;2具备使用JSP,Servlet,Filter,JavaBean等技术编写动态网站界面的能力;3具备在Web环境下创建,配置并编程访问MySQL数据库的能力;4具备项目开发中的团队协作能力;知识目标1掌握HTML,CSS,JavaScript等基本的网页编程知识;2掌握JSP,Servlet,Filter等动态网站开发的技术知识;3掌握JavaBean,JDBC等网站数据库访问的相关知识;4熟悉Web环境下文件操作,邮件编程等相关的知识;5了解JSTL,EL等知识网站中的常用技术;素质目标1沟通能力、团队合作及协调能力;2良好的编程习惯;3查阅相关手册及资料能力4掌握系统设计方法,培养严谨工作态度;5自我展示与语言表达能力;6责任意识;7分析和解决问题的能力;8科学的创造能力和创新精神;9获得适应未来岗位转变的迁移能力;10从事某一岗位可持续发展的能力;3、课程内容与要求本课程在教学过程中,提醒学生留意观察并思考生活中接触的Web系统应用,鼓励其结合生活中熟悉的操作方法提出问题或假设,在教师引导下,通过分析、推理,使学生自主学习、总结,以便增强学生对Java Web开发方法基本理论的理解;通过课堂讲解与讨论、案例分析等促进学生对所学理论的理解和运用,以培养其实际操作技能;充分利用现代教学手段,不断改进教学方式,突出典型案例的剖析,采用互动式教学使学生得到模拟训练,提高他们发现问题、分析问题、解决问题的能力;在课程内容的选择上,对Java Web开发工程师职业岗位的工作内容、工作过程、工作环境等加以分析提炼,进行相应的职业能力分解,对课程内容进行重构和重组,并按照循序渐进的教育规律进行深度加工,提取及序化教学内容;表1课程项目总体设计JSP声明page指令include指令JSP隐式对象include标签forward标签难点page指令include指令JSP隐式对象基本要求了解JSP的特点及其运行原理熟悉泛型的使用熟悉Collections和Arrays工具类的使用4、实施建议教学建议根据本课程的教学目标要求和课程特点以及有关学情,选择适合于本课程的最优化教学法;综合考虑教学效果和教学可操作性等因素,本课程选用项目教学法;项目教学法是学生在教师的指导下亲自处理一个项目的全过程,在这一过程中学习掌握教学计划内的教学内容;学生全部或部分独立组织、安排学习行为,解决在处理项目中遇到的困难,提高学生的兴趣,自然能调动学习的积极性;课程的教学以文件管理器项目为中心组织教学,并建立相应的教学情境,把Java Web开发知识与技能的学习置于真实的情境之中,让学生掌握工作过程性知识;在教学情境的逐步实施中,项目遵循从单一到综合,从简单到复杂的顺序安排,而教师指导工作量应逐渐减低,学生独立完成任务的程度应逐步提高,以逐步提高学生的综合职业能力;在每个学习情境的教学实施中,采用行动导向的教学方法,按照项目开发的具体过程进行组织教学,培养了学生的职业迁移能力;在教学中,注重团队合作、沟通协调能力、组织能力等软技能的培养;师资队伍建议本课程现有专任教师3名,本课程校内任课教师应通过硕士研究生以上相关专业的学习,本课程除在理论上指导学生外,在实践上也对教师提出了一定的要求,故而教师除Java Web 有较深的理解外,在实践操作能力上也应具备一定的能力,建议具有生产实践经验的教师担当此课程的教学任务,并具备相关教师资格证书,同时还应有相关岗位企业实践经历;企业兼职教师应具备工程师等级以上职称证书,语言表达能力达到要求;考核评价建议对课程考核内容、手段和方式进行改革与创新,课程考核围绕以能力为中心,将教学的全过程纳入考核范畴,增加学生日常知识积累、自主学习的考核,注重考核学生的实际编程能力,分析问题与解决问题的能力,从而使课程考核过程化、经常化和企业化;为了鼓励学生职业素质的培养,将考核内容多元化,而不局限于书本知识的考核,对学生的创新设计、职场能力、开源理念等都纳入考核范围,从而达到对学生知识、能力、素质的综合考察,形成对学生客观公正的评价;课程考核体系的实施以过程化考核为主导,量化考核指标,突出以学生为中心的指导思想;对职业素养的考核,突出学生的课堂表现和职业习惯,学生的每一次课堂突出表现都是其作为考核加分的机会,这有助于活跃课堂气氛,激发学生的学习热情和主动性;对综合能力的考核,将贯穿整个课程的案例项目分解为8个小任务,教师提供这些任务的详细的思维导图,学生根据这些帮助完成指定的任务;同时,在每个小任务中,都提出针对项目的具体优化设想和参考文档,鼓励学生在完成既有功能的基础上,个性化自己的项目功能;教材选用和编写建议1教材建设书名:JavaWeb程序开发入门主编:传播智客高教产品研发部出版社:清华大学出版社2网络资源建设学生学习端:课程资源开发与利用建议根据课程目标、学生实际以及本课程的专业性、应用性等特点,本课程的教学应该建设由文字教材、CAI课件等多种媒体教学资源为一体的配套教材,全套教材各司其职;以文字教材为中心,提供内涵不同,形式多样的学习支持服务,共同完成教学任务,达成教学目标;并辅以多媒体课件、项目设计思维导图、习题库、试题库、案例库等资源构建学生自主学习环境;1建设本课程学习网站,增加课程资源库建设,力争在在线拓展资源方面做到完整、全面;2产学合作开发实验实训课程资源,充分利用本行业典型的生产企业的资源,进行产学合作,建立实习实训基地,实践“做中学、学中做、边做边学”的育人理念,满足学生的实习实训,同时为学生的就业创造机会;3建立本专业开放实验室及实训基地,使之具备现场教学、实验实训、职业技能证书考证的功能,实现教学与实训合一、教学与培训合一、教学与考证合一,满足学生综合职业能力培养的要求;其它说明1本课程标准适用于物联网技术专业的学生;2本课程标准教学内容和要求与教材选用无直接关系;5、附录编制人:审核人:编制日期:年月日。
30.《Java Web开发技术》课程标准

ServletConfig 接口、ServletContext
ServletContext
接口
HttpServletResponse 对象
发送状态码相关的方法、发送响应消息 头相关的方法
HttpServletResponse 应用
中文输出乱码问题、网页定时刷新并跳 转、禁止浏览器缓存页面
HttpServletRequest 对象
8 Web 应用、配置 Web 应用虚拟目录、 Tomcat 的管理平台
配置虚拟主机
Eclipse 中配置 Tomcat 服务器
HTTP 概述
HTTP 介绍、HTTP 1.0 和 HTTP 1.1、HTTP 消息
HTTP 请求消息
HTTP 请求行、HTTP 请求消息头
8
HTTP 响应消息
HTTP 响应状态行、HTTP 响应消息头
什么是 Session、HttpSession API、
Session 对象
会话及其会
Session 超时管理
6
8
话技术
Session 案例—实现购物车 需求分析、案例实现
Session 案例—实现用户登录 需求分析、案例实现
JSP 概述 JSP 基本语法
JSP 运 行 原 理 、 分 析 JSP 所 生 成 的 Servlet 代码 JSP 模板元素、JSP 表达式、JSP 脚本 片段、JSP 声明、JSP 注释
(1)养成良好的思考和分析问题的素质; (2)养成较好的规范编码素质; (3)具备良好的职业道德和团队精神素质; (4)具备很好的与人沟通和交流的素质。
四、课程内容与教学安排
序号 项目/章节
1
XML 基础
Tomcat 开发 2
JAVA技术架构及开发规范文档

JAVA技术架构及开发规范文档一、概述二、技术架构1.三层架构基于业务功能的划分,将系统划分为表示层、业务逻辑层和数据持久层。
这样可以实现业务逻辑与表示层、数据持久层的解耦,提高代码的复用性和可维护性。
2.MVC模式使用MVC(Model-View-Controller)模式进行开发,将系统分为模型层、视图层和控制层,使各层之间的职责分明,提高代码的可维护性和可测试性。
3.面向对象设计原则遵循SOLID原则,尽量使用面向对象的设计和编程,其中包括单一职责原则、开闭原则、里式替换原则、接口隔离原则和依赖反转原则等。
三、开发规范1.命名规范采用驼峰命名法,变量名、方法名、类名等均应具有描述性,避免使用拼音或缩写。
2.代码风格代码应该具有良好的缩进和格式,增加代码的可读性。
要求适当添加注释,注释应说明代码的目的和使用注意事项。
3.异常处理合理处理异常,避免直接抛出异常,而是进行捕获和处理。
对于特定的业务异常,可以定义自定义异常类,并进行抛出。
4.注释规范需要对代码进行充分的注释,注释的风格应明确,注释应配合代码,解释代码的用途和作用。
5.单元测试开发过程中应进行单元测试,确保代码的正确性。
对于每个功能模块,编写相应的单元测试用例进行测试,覆盖率应尽量达到100%。
6.安全性对于涉及到的用户输入数据和敏感数据,应进行有效的验证和过滤,防止恶意注入和跨站脚本攻击等安全威胁。
7.日志规范所有的关键操作和错误信息都应记录到日志中,日志级别应根据实际需要进行配置。
8.数据库规范数据库表设计应符合第三范式,避免数据冗余和数据不一致。
使用参数化查询和预编译语句,提高数据库查询性能和安全性。
9.版本管理使用版本管理工具(如Git)进行代码管理,每个开发人员都应具备良好的版本管理和协同开发能力。
四、总结本文档主要介绍了JAVA技术架构及开发规范。
通过采用三层架构和MVC模式,可以实现代码的复用性和可维护性。
同时,遵循JAVA的面向对象设计原则,提高代码的可测试性和可扩展性。
搭建Java Web开发环境

1 搭建Java Web开发环境1.1 Java Web开发环境概述设计与开发Java Web应用程序,需要开发的软件系统,称为“开发环境”。
Java Web应用程序的开发环境包括:JDK、Web服务器、数据库系统、Web浏览器。
1、JDK——Java语言程序包JDK的功能是编写、调试与运行Java程序,是Java程序设计的最基本的软件系统,最新的版本是Jdk-6u23(软件名称是:jdk1.6.0_23)。
JDK的主要部件及功能有:(1)编译与运行程序Java程序Javac.exe——用于将Java源程序文件编译为“字节码”文件。
Java.exe——运行编译好的字节码文件,显示程序运行结果。
(2)JREJRE是Java运行环境。
(3)JVMJVM是Java的虚拟机,是JRE的核心部分。
设计和运行Java程序,必须依靠JDK。
2、Java Web服务器(中间件)Web服务器是运行Java Web应用程序的容器,只有将设计开发的Java Web应用程序(B/S架构应用系统)放置在这样的容器中,才能使网络上的用户通过浏览器进行访问。
目前,主要的Java Web 服务器有以下几种:(1)Apache Tomcat是目前应用最广、最为流行的小型、轻量级Web服务器,它支持JSP和Servlet(服务器端的Applet)技术。
它是开源和免费的,也是目前学习与开发Java Web应用程序的首选。
可用于开发中小型的Java Web应用软件。
(2)EBA WebLogicEBA WebLogic是EBA公司开发的Java Web服务器,它有三个版本:企业版WebLogic Server,标准版WebLogic Enterprise,简化版WebLogic Portal。
WebLogic的功能强大,支持企业级、多层次的分布式Web应用。
但是使用成本高,一个标准版的WebLogic在一台计算机上使用授权费用需要8.5万元。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
Java web开发规范1、前言为了使软件开发过程有章可循,保证软件质量,加强开发管理。
2、开发管理项目进度周报表格如下:项目编号汇报人汇报日期项目进度详细描述其他问题3、命名规范3.1项目编号命名规范命名方式:项目英文/中午拼音名称_开发组编号_序列号序列号由3为数字组成,不足的用’0’补齐。
3.2文档命名规范命名方式:项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号3.3jsp/html命名规范1、jsp与html文件名全部小写,并遵循如下的规范:a.数据/内容显示页:名词,多个单词用下划线分隔,要求能说明显示内容的信息,为避免冲突,可加上“_list”。
例如:new_message.html或my_file_list.jspb.操作处理页命名格式:名词_下划线_动词,例如:file_delete.jsp。
c.含frame页面<frameset>中<frame>的name属性命名的格式是①xxx_②xxx_③xxx①xxx部分用来标识当前页面隶属于整个系统中的哪一功能模块。
如:属于ebwebmail模块则写ebwebmail,其它情况依次类推。
②xxx部分标识当前页面所要完成的功能。
如:完成用户登录的功能则被标识为login,其它情况依次类推。
③xxx部分用来用来表示页面在浏览器窗口所处的位置。
处于浏览器窗口的顶部则标识为top,其它情况依次类推。
例如:ebwebmail_inbox_top.jsp<frame>src属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。
2、javascript脚本文件命名方式:脚本函数都以①xxx_②xxx的方式命名。
①xxx对应页面隶属的模块。
②xxx表示函数所要实现的功能(动宾结构),多个单词用下划线连接。
例如:ebwebmail_send_mail()模块通用的脚本函数必须集合于一个js文件中,在页面上通过<scriptlanguage=”javascript”src=”url”></script>形式导入。
js文件名命名使用模块名,例如:ebwebmail.js。
如果项目已经提供了公共js脚本,则优先使用公共js脚本中提供的函数。
所有定义方法的<script>元素定义在<head></head>中或</body>后。
3、javascript脚本内部变量与参数单词之间用下划线分隔且全部小写,例如:var file_size。
<form>表单name属性统一以“form_”开头,其后加该表单所需收集的信息的作用或动作,例如:form_file_upload或form_send_mail。
表单elements表单element的名称以element需收集的信息标示命名(与struts中的属性名对应),其他element单词之间使用下划线分隔且全部小写,例如:<input type=”text”name=”username”>-username为struts中的属性名username<input type=”radio”name=”file_type”>-不与struts对应表单元素名4、cookie命名命名格式:模块名_存储信息名词(多个单词用下划线分隔),全部大写,例如:EBWEBMAIL_SORT_TYPE。
5、window.open中name参数的命名javascript的window.open方法中有一个name的参数,浏览器约定同样的名字的窗口只能打开一个,如果程序间名字重复将相互冲突。
如果不限制打开窗口数,可以指定‘’或“”(不是null),否则需要加上模块名,例如ebwebmail_viewmail。
3.4数据库命名规范数据库表命名均遵循以下规范:模块名_存储信息名词(多个单词用下划线分隔),全部小写,例如:ebwebmail_message。
数据库字段命名遵循以下规范:存储信息名词(多个单词用下划线分隔),全部小写,例如:message_id。
4、文档规范1.编写文档目前主要使用的工具是Word(项目计划文档例外,需要使用Project制作),辅助使用的工具有Visio,PowerPoint,Excel等。
2.文档务必保持段落格式整齐,文字字体,颜色,大小统一。
3.如果需要摘引html页面中的内容,不能直接从html中粘贴过来(会在word文档中留下html格式),而必须先去除格式,例如:先粘贴到notepad中。
4.务必注意中英文标点符号,文档正文一概使用中文标点符号。
5.如果需要在文档中插图,不要使用word自带的绘图工具。
可以选择使用PowerPoint或visio。
使用PowerPoint,选择“插入”->“对象”->“Microsoft PowerPoint幻灯片”。
使用visio,需要另外建立visio文档,绘制完以后粘贴到word中。
6.数据建模使用powerdesigner工具,文档中仅需要粘贴数据模型的逻辑视图(logicalview),另外还要附上表结构描述。
7.修改他人文档务必使用修订模式,以便保留备修改的内容。
使用修订模式,选择“工具”->“修订”->“突出显示修订”,勾上“编辑时标记修订”。
附:一些模版Java类设计文档(class documentation)声明:描述:创建人:创建时间:属性:1.property_name声明:说明:创建人:创建时间:方法: 1.method_name声明:说明:参数:返回值:异常:创建人:创建时间:如需修改加上:修改人:修改时间:修改原因:三个描述信息注:方法声明中,如果遇到重载的方法,可以使用“|”表示可以接受不同类型的参数,例如:“String value|int value”;可以使用“[]”表示可选的参数,例如:“Objectmessage[,Throwable t]”Servlet设计(servlet document)类名接受参数列表描述数据表设计(data modeling)表名:some_table说明:description表结构:字段名类型说明5、代码规范5.1Java源代码规范5.1.1命名1、Package的命名Package的名字应该都是由一个小写单词组成,例如:net.ebseries.modules。
此外,对于包名我们做如下约定:1.工具函数类包名前缀为.util2.Servlet类包名前缀为.servlet3.test case类包名前缀为.test2、Class的命名Class的名字必须由大写字母开头而其他字母都小写的单词组成,例如:DataFile或InfoParser。
3、Class变量的命名变量的名字必须用一个小写字母开头。
后面的单词用大写字母开头,例如:debug或inputFileSize。
4、Static Final变量的命名Static Final变量的名字应该都大写,并且指出完整含义,例如:MAX_UPLOAD_FILE_SIZE=1024。
5、参数的命名参数的名字必须和变量的命名规范一致。
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:setSize(int size){this.size=size;}6、数组的命名数组应该总是用下面的方式来命名:byte[]buffer;而不是:byte buffer[];7、方法的命名方法的命名以一个小写字母开头。
后面的单词用大写字母开头,例如:debugMethod()或inputFile()。
5.1.2代码格式文件头声明源文件的头部需要一个history段,对于每次对源文件的重大改动,都需要在history 段中注明。
该段定义在package和import之间,例如:/******************************************************HISTORY**2002/01/29Biz创建文件**2002/02/19kevin增加XX功能**2002/03/01ben增加xx功能*******************************************************/import顺序import包按一下顺序:1.jdk标准包2.java扩展包(例如servlet,javamail,jce等)3.使用的外部库的包(例如xml parser)4.使用的项目的公共包5.使用的模块的其他包每一类import后面加一个换行。
例如:import java.io.*;import java.util.*;import javax.servlet.*;import javax.mail.*;import org.apache.xml.*;import net.ebseries.*;import net.ebseries.util.*;import net.ebseries.ebwebmail.*;代码块书写格式可以选择以下任意一种代码块的书写方式:if(true){//body}或if(true){//body}建议使用第二种书写方式。
如果是修改他人的代码,必须使用代码原来的书写方式。
对于代码块过长,超过1屏以上,}后面要说明属于那个代码块,例如:if(i>100){//too many lines more than one screen}//if(i>100)关于缩进缩进使用4个连续空格,不要在源文件中保存tab字符,请注意调整所用的IDE 工具,打开将tab转换为空格功能。
页宽页宽应该设置为80字符.源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整.在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行.一条语句折行后,应该比原来的语句再缩进4个空格。
操作符操作符左右各用一个空格分隔。
例如:int a=b;if(a>0);SQL语句代码中书写的sql语句要求sql关键字全部大写,表名和字段名小写。
例如:SELECT user_id,name FROM account WHERE user_id>?AND depart=?ORDER BYname类和方法定义类定义或方法定义过长需要换行书写,例如:public class CounterSetextends Observableimplements Cloneableprivate PortletSet getPortlets(Portlets portlets,RunData rundata,boolean application,boolean applicationsOnly){}5.1.3注释public和protected的成员变量和方法必须写javadoc注释。