jsp开发规范.doc

项目/产品开发规范JSP编码规范()文档信息文档分类项目/¨公开资料þ内部资料¨保密资料¨机密资料文档状态þ初稿¨讨论稿¨发布þ表示选中,¨-2-22初稿审核批准批准组织批准部门签名版权声明XX公司,版权所有,保留一切权利。本文件中出现的任何文字叙述、文件格式、插图、照片、方法、过程等内容,除另有特别注明,版权均属XX公司所有,受到有关产权及版权法保护。任何个人、机构未经XX公司的书面授权许可,不得复制或引用本文件的任何片断(无论通过电子形式或非电子形式),并不得以任何形式传播。文件命名文件名按照unix的命名习惯,文件名用小写字母,如果名字是由两个或以上单词构成,从第二个单词开始,第一个字母大写,一般不用下划线连接,不要用中文拼音和英文单词混用。JSP程序要尽量做到简洁要作到这步必须先把页面的风格确定。然后对页面进行拆分。一般可以分出4个部分。第一个部分是页面的头:第二个部分是标签部分。第三个部分是动态实现部分(写的程序实现一般在这个部分实现),第四个部分是页面的尾部。要保证第一,二,四这三个部分是所有的程序公用部分。这样的修改起来方便。程序实现起来只操作第三部分,这样程序看起来简单、易读。与javascript代码分离所有的JS应该单独写到公共的目录里面去。然后在页面的开始这样包含进来<scriptsrc="../../../js/"></script>第三部分实现规范因为程序代码都是写在这里的所以JSP程序需要规范的地方主要是这里。变量名:以小写字母和数字组成,可以用单词和中文拼音的简写,但是要求注明其对应的中文,如果是多个单词组成,其书写和文件名要求一样,第二个单词首字母大写。定义变量的时候要尽量规范(满足命名规则),定义的时候要说明变量的含义。如intEnterpriseCount=0;//企业总数代码书写:要求代码段落清晰,每一层嵌套都要求缩进一个tab键(4位长度),一段功能或流程结束后要加上一个空行。每个程序文件要求java代码和html代码分离,方便日后系统维护和随时修改风格。按照目前的例子,流程控制文件拷贝并改名后只修改其中的include的模块和按需求include的label部分,其他的不动。在模块文件中只需form和table等简单的HTML对象即可,页面中不要在html代码中加入页面显示的风格设定,方便界面的统一和控制,如果要使用,在css/,然后再引用,如class=”myStyle”。并且不能加入java设定的charset,否则会出错。模块:如果是可以作为模块(modul)使用的jsp文件,要求放在根下的modul目录下,其命名是该模块的功能加上modul作为文件名,;如果不能作为模块使用,要求其命名方式和作为模块时一样,只是放在其自身目录下。在模块文件中,其form中的action不能有值,保持其为空,提交时可以用;的方式来修改或者使用获得当前页面的文件名的js函数来获取。按钮:所有的按钮都是使用图片,不用浏览器默认的各种button。要求用图片和超链,其写法如下:<ahref=”javasc