web前端开发规范手册

'Web前端开发规范手册Web前端开发规范手册修订历史记录日期版本说明作者2012年12月31日1.0初稿施昀2012年01月05日1.1施昀、戴静2012年01月07日1.2施昀目录修订历史记录1一、规范目的21.1概述2二、基本准则2三、文件规范32.1文件命名规则32.1.1HTML的命名原则32.1.2图片的命名原则32.1.3.javascript的命名原则42.1.4动态语言文件命名原则42.2文件存放位置规范42.3CSS书写规范42.3.1基本原则412 Web前端开发规范手册2.3.2注意细则52.3.3命名规则62.4html书写规范92.4.1head区代码规范92.4.2body区代码规范102.5JavaScript书写规范102.6图片规范102.7注释规范112.7.1html注释112.7.2css注释112.7.3JavaScript注释11四、执行模式12一、规范目的1.1概述Ø提高团队协作效率Ø便于前端开发以及后期优化维护Ø方便新进的成员快速上手Ø输出高质量的代码本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更新此文档。二、基本准则Ø符合web标准,语义化html,结构表现行为分离,兼容性优良。Ø代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度。12 Web前端开发规范手册开发时需要遵循如上基本准则，特殊情况可以有所宽限，如一些老项目的页面改造。三、文件规范2.1文件命名规则[使用场景：在新建网页、图片、脚本、CSS文件时，根据此规则给文件命名并放入指定位置]文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字空格和特殊字符。命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。2.1.1HTML的命名原则索引文件统一使用index.htmindex.htmlindex.asp文件名。各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如：子页命名关于我们aboutus信息反馈feedback产品product如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示。每一个目录中应该包含一个缺省的html文件，文件名统一用index.htmindex.htmlindex.asp。2.1.2图片的命名原则图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。例如：广告、标志、菜单、按钮等等。Ø放置在页面顶部的广告、装饰图案等长方形的图片取名：bannerØ标志性的图片取名为：logoØ在页面上位置不固定并且带有链接的小图片我们取名为buttonØ在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menuØ装饰用的照片我们取名：picØ不带链接表示标题的图片我们取名：title范例：banner_sohu.gifbanner_sina.gifmenu_aboutus.gifmenu_job.giftitle_news.giflogo_police.giflogo_national.gifpic_people.jpg12 Web前端开发规范手册2.1.3.javascript的命名原则一般使用脚本功能的英文小写缩写命名。例如：广告条的javascript文件名为ad.js弹出窗口的javascript文件名为pop.js2.1.4动态语言文件命名原则以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。范例：register_form.aspregister_post.asptopic_lock.asp2.2文件存放位置规范文件夹说明flash存放flash文件images存放图片文件inc存放include文件library存放DW库文件media存放多媒体文件script存放javascript脚本css存放css文件2.3CSS书写规范[使用场景：书写CSS样式时，根据此规则对id和class进行命名，并遵循书写规则，避免出现常犯错误，提高效率。]2.3.1基本原则CSS样式可细分为3类：重新定义HTML样式、链接状态样式、自定义样式。1.重新定义HTML样式为设计师重新定义已有的HTML标签样式，影响全部的被设定标签样式，用于统一网页中某一标签的样式定义。样式名“HTML标签”例：hr{border:1pxdotted#333333}2.链接状态样式为设计师对链接不同状态设定特殊样式，影响被使用本样式区域中的链接。该样式写法有2种：a.nav:link(中间无空格)、.nava:link第一种只能修饰标签中；第二种可以修饰所有包含有标签的其他标签。3.样式为设计师自定义的新CSS样式，影响被使用本样式的区域，用于完成网页中局部的样式设定。样式名“.”+“相应样式效果描述的单词或缩写”例：“.shadow”文字样式样式名“.no”+“字号”+“行距”+“颜色缩写”例：“.no12”、12 Web前端开发规范手册“.no12_24”“.no12”类型一般出现在base.css文件中，只可选用，不可修改，避免名称含义和实际内容不符。自定义的样式名最好用意义命名。比如：重要的新闻高亮显示（像红色），有两种写法：red{color:red}；.important_news{color:red}；很显然第二种传达的意义更加明确,所以尽量不要用意义不明确的作为自定义命名。4.页面内的样式加载必须用链接方式：5.重新定义的最先，伪类其次，自定义样式最后，便于自己和他人阅读。6.一般不允许将样式的定义写在标签中（如：style=“color:red;”）；7.所有装饰性的图片（如背景图），要定义在CSS中；2.3.2注意细则1.class与id命名:大的框架命名比如header/footer/wrapper/left/right之类的由设计框架之人统一命名。其他样式名称由小写英文&数字&_来组合命名,避免使用中文拼音,尽量使用简易的单词组合;总之,命名要语义化,简明化。2.规避class与id重名,不建议使用id选择器。a.通过从属写法规避,示例见d;b.取父级元素id/class命名部分命名,示例见d;c.重复使用率高的命名,可加代号加下划线起始,比如i_clear;d.a、b两条,适用于在2中已建好框架的页面,如,要在2中已建好框架的页面代码