护性,提高软件产品质量,有必要对软件产品的源程序的编写风格做出统一的规范约束。本规范的内容包括:网站工程、目录结构、HTML、脚本、图片、多媒体等。
三文章注释
文中出现的公式,以中括号“”括起来的部分,是可选部分。文中出现蓝线浅灰色的文字部分,表示演示代码、代码说明。
第二章目录结构规范
创建目录的原则是:对工程中所有的资源进行归类存放,并考虑可能存在的各种业务需求,例如访问权限。同时,当代码交付于另一个开发者时,对方能非常明确的知道各个目录的意义,能方便快捷的
第3页共31页
f288546051doc
查找到相关的资源文件。目录结构应开设images,css,script三个文件夹,分别存放图片资源、CSS样式表定义文件和脚本,有些项目还使用了其他的一些网页相关的资源,如flash、avi、rm、i
clude等,可开设commo
目录来存放这些资源。images目录中放不同栏目的页面都要用到的公共图片,如果图片较多,可按图片的职能类型,再划分子目录。根目录一般只存放首页,以及其他必须的系统文件,每个主要栏目开设一个相应的独立目录。目录命名规范除非有特殊情况,目录的名称全部用小写英文字母、数字、下划线的组合,其中不得包含汉字、空格和特殊字符;目录的命名请尽量以英文为指导。名字结构参照微软的命名习惯,以多个单词连接形成,其中第一个单词首字母小写,后面的单词首字母大写,例如:systemMa
age。对于过长的单词,可采用常规缩写,例如departme
t的常规缩写是dept,原则上以他人能迅速理解为准。网页的命名规范指导思想:一是使得每一个成员能够方便的理解每一个文件的意义,二是当在文件夹中使用“按名称排例”的命令时,同一种大类的文件能够排列在一起,以便查找、修改、替换、计算负载量等等操作。禁止使用中文命名。静态Html网页,为了统一拓展名,规定为htm,而不是html;
第4页共31页
f288546051doc
图片的命名规范:应将相同类型的图片,让它们放置在一起,类型参照下面的定义;◇广告、装饰图案等图片取名:ba
er,或bar◇标志性的图片取名为:logo◇在页面上位置不固定并且带有链接的小图片取名为butto
,或bt
◇在页面上某一个位置连续出现,性质相同的链接图片取名:me
u◇装饰用的照片取名:pic◇不带链接表示标题的图片取名:title◇依照此原则类推。
命名的方法为:
类型名_英文含义区分符
例如butto
_searchUsergif,memu_se
dNoticegif,禁止使用中文命名。
第三r