JSP和HTML编码规范

《JSP和HTML编码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、概要设计文件编号：Q/KC-JL-RJ-24目录1.介绍41.1.为什么要有编码规范42.命名规则42.1.JSP和HTML页面42.1.1.含frame页面42.2.javascript脚本53.目录存放规范53.1.目录存放范例5湖南纵合科技有限公司第4页概要设计文件编号：Q/KC-JL-RJ-241.介绍1.1.为什么要有编码规范编码规范对于程序员而言尤为重要，有以下几个原因：1.一个软件的生命周期中，80%的花费在于维护；2.几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；3.编码规

2、范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码；4.如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品；为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。2.命名规则2.1.JSP和HTML页面jsp与html文件名全部小写，存放位置应该按照模块分开来存放，不允许前台和后台公共使用某个页面，但是允许共用css、javascript、图片等。并遵循如下的规范：页面类型命名规则1.数据/内容显示页数据/内容显示页文件用名词命名，多个单词用下划线分隔

3、，要求能说明显示内容的信息，为避免冲突，可加上“_list”。例如：new_message.html或my_file_list.jsp2.操作处理页操作处理页的命名格式：名词_动词，例如：file_delete.jsp。2.1.1.含frame页面frame标签属性命名规则1.含frame页面的name属性名称分为三部分，命名格式为①_②_③1.第①部分用来标识当前页面隶属于整个系统中的哪一功能模块。如：属于ebwebmail则被表示为ebwebmail，其它情况依次类推。2.第②部分标识当前页面所要完成的功能

4、。如：完成用户登录的功能则被标识为login，其它情况依次类推。3.第③部分用来用来表示页面在浏览器窗口所处的位置，具体包括：top,center,bottom,left,right处于浏览器窗口的顶部则标识为top，其它情况依次类推。例如：ebwebmail_inbox_top.jsp湖南纵合科技有限公司第4页概要设计文件编号：Q/KC-JL-RJ-241.含frame页面的src属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置（top,center,bottom,left,right）。

5、1.1.javascript脚本标识符类型命名规则1.文件的命名同JAVA类的命名规则：为一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)2.函数的命名同JAVA方法的命名规则：为一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。3.函数内的变量采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头。变量名应简短且富于描述。变量名的选

6、用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。4.全局变量大小写规则与函数内的变量名相似，除了前面需要一个下划线2.目录存放规范2.1.目录存放范例顶级一级目录二级目录三级目录四级目录五级目录简要描述<系统代码>WEB-INFlib系统JAVA包classes系统classes文件srccomchinacreator系统代码common系统公用JAVA文件子系统1、、、testcom

7、chinacreator系统代码common公用文件单元测试文件子系统1、、、resourcejs系统公用JS文件images系统公用图片文件css系统公用CSS文件子系统1resourcejs子系统JS文件images子系统图片文件湖南纵合科技有限公司第4页概要设计文件编号：Q/KC-JL-RJ-24css子系统CSS文件模块1子系统JSP和HTML文件子系统2、、、说明：1.网站目录的命名：a)目录建立的原则是以最少的层次提供最清晰简便的访问结构。b)对于一些信息更新量比较大的站点或是栏目，还可以采用一种更

8、为特殊的方式来进行文件夹的命名，这样能使得日后的维护更加方便，这样的方式就是使用“单一单词命名的目录”+“年年年年_月月_日日”的方式命名。c)按目录名的英语翻译取单一单词为名称。例如：关于我们aboutus　　　　　客户服务service　　　产品专区product2.文件的存放：a)根目录只允许存放index.html和main.html文件，以及其他必须的系统文件。b)一级