一、规范目的
1.1概述
为提高团队协作效率,便于后台人员添加功能及前端后期优化维护,输出高质量的文档,特制订此文档.本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发.本文档如有不对或者不合适的地方请及时提出,经讨论决定后可以更改此文档.
二、文件规范
2.1文件命名规则
文件名称统一用小写的英文字母、数字和下划线的组合,其中不得包含汉字、空格和特殊字符;命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义,二是当我们在文件夹中使用“按名称排例”的命令时,同一种大类的文件能够排列在一起,以便我们查找、修改、替换、计算负载量等等操作。
a.HTML的命名原则
引文件统一使用index.htmindex.htmlindex.asp文件名(小写)各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如:关于我们\aboutus信息反馈\feedback产品\product如果栏目名称多而复杂并不好以英文单词命名,则统一使用该栏目名称拼音或拼音的首字母表示;每一个目录中应该包含一个缺省的html文件,文件名统一用index.htmindex.htmlindex.asp;
b.图片的命名原则图片的名称分为头尾两部分,用下划线隔开,头部分表示此图片的大类性质例如:广告、标志、菜单、按钮等等。放置在页面顶部的广告、装饰图案等长方形的图片取名:banner标志性的图片取名为:logo在页面上位置不固定并且带有链接的小图片我们取名为button在页面上某一个位置连续出现,性质相同的链接栏目的图片我们取名:menu装饰用的照片我们取名:pic
不带链接表示标题的图片我们取名:title
范例:
banner_sohu.gifbanner_sina.gifmenu_aboutus.gifmenu_job.giftitle_news.giflogo_police.giflogo_national.gifpic_people.jpg
鼠标感应效果图片命名规范为"图片名+_+on/off"。
例如:menu1_on.gifmenu1_off.gif
c.javascript的命名原则
例如:广告条的javascript文件名为ad.js弹出窗口的javascript文件名为pop.js
d.动态语言文件命名原则以性质_描述,描述可以有多个单词,用“_”隔开,性质一般是该页面得概要。范例:
register_form.aspregister_post.asptopic_lock.asp
2.2文件存放位置规范
_Rootcn存放中文HTML文件
en存放英文HTML文件
flash存放Flash文件
images存放图片文件
imagestudio存放PSD源文件
flashstudio存放flash源文件
inc存放include文件
library存放DW库文件
media存放多媒体文件
project存放工程项目资料
temp存放客户原始资料
js存放JavaScript脚本
css存放CSS文件
本文是我在桂林学习Web前端开发时候杂糅老师讲的和自己的心得体会,希望自己能够成为桂林顶级的Web前端开发工程师,也希望能够抛砖引玉,学习交流进步~