Web前端开发规范手册.doc

《Web前端开发规范手册.doc》由会员分享，可在线阅读，更多相关《Web前端开发规范手册.doc（12页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、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.1 HTML的命名原则32.1.2 图片的命名原则32.1.3. javascript的命名原则42.1.4 动态语言文件命名原则42.2 文件存放位置规范42.3 CSS 书写规范42.3.1 基本原则42.3.2 注意细则52.3.3 命名规则62.4 html 书写规范92.4.1 head区代码规范92.4.2 body区代码规范

2、102.5 JavaScript书写规范102.6 图片规范102.7 注释规范112.7.1 html注释112.7.2 css注释112.7.3 JavaScript注释11四、执行模式12一、规范目的1.1 概述 提高团队协作效率 便于前端开发以及后期优化维护 方便新进的成员快速上手 输出高质量的代码本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更新此文档。二、基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良。 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度。

3、开发时需要遵循如上基本准则，特殊情况可以有所宽限，如一些老项目的页面改造。三、文件规范2.1 文件命名规则使用场景：在新建网页、图片、脚本、CSS文件时，根据此规则给文件命名并放入指定位置文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字空格和特殊字符。命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。2.1.1 HTML的命名原则索引文件统一使用index.htm index.html index.asp文件名。各子页

4、命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如： 子页命名关于我们 aboutus信息反馈 feedback产 品 product如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示。每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm index.html index.asp。2.1.2 图片的命名原则图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。例如：广告、标志、菜单、按钮等等。 放置在页面顶部的广告、装饰图案等长方形的图片取名： banner 标志性的图片取名为： logo 在页面上位置不固定并且带

5、有链接的小图片我们取名为 button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名： menu 装饰用的照片我们取名： pic 不带链接表示标题的图片我们取名： title 范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg2.1.3. javascript的命名原则一般使用脚本功能的英文小写缩写命名。例如：广告条的javascript文件名为 ad.js 弹出窗口的jav

6、ascript文件名为 pop.js2.1.4 动态语言文件命名原则以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。范例：register_form.asp register_post.asp topic_lock.asp2.2 文件存放位置规范文件夹说明flash存放flash文件images存放图片文件inc存放include文件library存放DW库文件media存放多媒体文件script存放javascript脚本css存放css文件2.3 CSS 书写规范使用场景：书写CSS样式时，根据此规则对id和class进行命名，并遵循书写规则，避免出现常犯错误，提高

7、效率。2.3.1 基本原则CSS样式可细分为3类：重新定义HTML样式、链接状态样式、自定义样式。1. 重新定义HTML样式为设计师重新定义已有的HTML标签样式，影响全部的被设定标签样式，用于统一网页中某一标签的样式定义。样式名“HTML标签”例：hr border: 1px dotted # 2. 链接状态样式为设计师对链接不同状态设定特殊样式，影响被使用本样式区域中的链接。该样式写法有2种： a.nav:link(中间无空格) 、.nav a:link 第一种只能修饰标签中；第二种可以修饰所有包含有标签的其他标签。3. 样式为设计师自定义的新 CSS 样式，影响被使用本样式的区域，用于完

8、成网页中局部的样式设定。样式名 “.”+“相应样式效果描述的单词或缩写”例：“ .shadow ”文字样式样式名“.no”+“字号”+“行距”+“颜色缩写”例：“ .no12 ” 、“ .no12_24 ”“.no12”类型一般出现在base.css文件中，只可选用，不可修改，避免名称含义和实际内容不符。自定义的样式名最好用意义命名。比如：重要的新闻高亮显示（像红色），有两种写法：redcolor:red；.important_newscolor:red；很显然第二种传达的意义更加明确,所以尽量不要用意义不明确的作为自定义命名。4. 页面内的样式加载必须用链接方式：5. 重新定义的最先，伪类其

9、次，自定义样式最后，便于自己和他人阅读。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命名部

10、分命名, 示例见d; c. 重复使用率高的命名,可加代号加下划线起始, 比如i_clear; d. a、b两条, 适用于在2中已建好框架的页面, 如, 要在2中已建好框架的页面代码中加入新的div元素,按a命名法则: ., 样式写法: #mainnav .firstnav.按b命名法则: ., 样式写法: .main_firstnav.3. css属性书写顺序, 建议遵循 布局定位属性-自身属性-文本属性-其他属性。此条可根据自身习惯书写, 但尽量保证同类属性写在一起。文件夹说明布局定位属性Marginpaddingfloatclearposition（相应的 top,right,bottom

11、,left）displayvisibilityoverflow等自身属性Widthheightbackground border文本属性fontcolortext-aligntext-decorationtext-indent white-spaceothertextcontent等其他属性list-style(列表样式)vertical-aligncursorz-index(层叠顺序) zoom等4. 书写代码前, 考虑并提高样式重复使用率;5. 杜绝使用 兼容ie8;6. 避免兼容性属性的使用, 比如text-shadow | css3的相关属性;7. 减少使用影响性能的属性, 比如pos

12、ition:absolute | float ;8. 重要图片加上 alt 属性；重要的元素和截断的元素加上title;9. 避免使用!important，!important的优先级最高;10. 必须为大区块样式添加注释, 小区块适量注释;11. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化统一处理;12. Margin、padding、border、font等样式尽可能采用合并写法;上面的简写图解说明的是依据不同的属性值可以进行不同的缩写，这种方法同样适用于padding和Border-width属性;Font的简写对于缩小代码量很有帮劣，如果没有定义某个属性值的话，将继承

13、父级元素的定义或使用默认值。2.3.3 命名规则页面结构容器: container/wrap整体宽度：wrapper页头：header内容：content页面主体：main页尾：footer侧栏：sidebar栏目：column中间内容：center导航导航：nav主导航：mainbav/globalnav子导航：subnav顶导航：topnav边导航：sidebar左导航：leftsidebar右导航：rightsidebar边导航图标：sidebarIcon菜单：menu子菜单：submenu标题: title功能标志：logo登陆：login登录条：loginbar注册：regsiter

14、产品：products产品价格：products_prices产品评论：products_review编辑评论：editor_review最新产品：news_release最新产品：news_release广告/标语：banner摘要:summary生产商：publisher缩略图：screenshot常见问题：faqs关键词：keyword博客：blog论坛：forum搜索：search搜索输入框：search_input搜索输出：search_output搜索结果：search_results加入我们：joinus状态：status按钮：btn滚动：scroll标签页：tab文章列表：li

15、st提示信息：msg/message当前的: current小技巧：tips皮肤：skin充值：pay活动：activities推广：promotion公告：announcement排行：ranking公司简介：company_profile公司设备：equipment公司荣誉：glories企业文化：culture企业规模：scale营销网络：sales_network组织机构：organization技术力量：technology分支机构：branches企业资质：enterprise_qualification公司实力：strength_strength经营理念：operation_pr

16、inciple经理致辞：manager_oration发展历程：development_history工程案例：engineering_projects分类浏览：browse_by_category应用领域：application_fields人力资源：human_resource_hr领导致辞： leader_oration客户留言：customer_message客户服务：customer_service您的要求：your_requirements销售信息：sales_information招商：enterprise_establishing教育培训：education_training在

17、线交流：online_communication质量认证：quality_certification合作加盟：joinIn_cooperation产品描述：products_description业务范围：business_scope产品销售：sales_sales联系我们：contact_us信息发布：information返回首页：homepage产品定购：order电子商务：e_business版权所有：copy _right友情连结：hot_link行业新闻：trade_news行业动态：trends邮编：postal_code_zipcode新闻动态：news_trends公司名称：

18、company_name销售热线：sales_hotline联系人：contact_person建设中：in_construction证书：certificate地址：add电话：tel传真：fax产品名称：product_name产品说明：description价格：price品牌：brand规格：specification尺寸：size生产厂家：manufacuturer型号：model产品标号：item_no技术指标：technique_data产品描述：description产地：production_place用途：application论坛：forum在线订购：on_line_or

19、der招标：bidInviting综述：general业绩：achievements大事：great_event动态：trends服务：service投资：investment行业：industry规划：programming环境：environment发送：delivery提交：submit重写：reset社区：community业务：business在线调查：online_inquiry下载中心：download意见反馈：feedback常见问题：faq中心概况：general_profile游乐园：amusement_park专题报道：special_report图标: icon注释：n

20、ote指南：guild服务：service热点：hot新闻：news下载：download投票：vote商标：label/branding当前位置：breadcrumb/loc购物车：shop标签：tag信誉：siteinfo_credits网站信息：siteinfo法律声明：siteinfo_legal合作伙伴：partner友情链接：friendlink版权：copyright2.4 html 书写规范使用场景：书写html页面时，根据此规则对html内容进行补充和完善。2.4.1 head区代码规范 head区是指HTML代码的和之间的内容。 必须加入的标签 1. 网页显示字符集 简体中

21、文：繁体中文：英 语：2. 搜索关键字（网站类型） 3. 网页的css规范 4. 网页标题 xxxxxxxxxxxxxxxxxx 可以选择加入的标签 1.公司版权注释 2. 网页制作者信息 3. 网站简介4. 设定网页的到期时间。一旦网页过期，必须到服务器上重新调阅。 5. 禁止浏览器从本地机的缓存中调阅页面内容。 6. 用来防止别人在框架里调用你的页面。7. 自动跳转。 5指时间停留5秒8. 网页搜索机器人向导。用来告诉搜索机器人哪些页面需要索引，哪些页面不需要索引。CONTENT的参数有all,none,index,noindex,follow,nofollow。默认是all。 9. 收藏

22、夹图标 10. 所有的javascript的调用尽量采取外部调用. 2.4.2 body区代码规范1. 附标签： 标签不属于head区，这里强调一下，为了保证浏览器的兼容性，必须设置页面背景（此处为示意，样式需写在CSS文件中）2. 在浏览器里，当我们点击空链接时，它会自动将当前页面重置到首端，从而影响用户正常的阅读内容，我们用代码“javascript:void(null)”代替原来的“#”标记。链接2.5 JavaScript书写规范使用场景：书写js脚本时，根据此规则对变类、函数、变量命名，并遵循书写规则，避免出现常犯错误，提高脚本效率。1. 书写过程中, 每行代码结束必须有分号; 原则

23、上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 | 与现有代码冲突 | .);2. 库引入: 原则上仅引入jQuery库,以及组件组开发的相关库。 若需引入第三方库, 须与团队其他人员讨论决定;3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun; jQuery私有变量要求首字符为_, 其他与原生JavaScript 规则相同, 如: _iTaoLun; 另, 要求变量集中声明, 避免全局变量.4. 类命名: 首字母大写，如 ITaoLun;5. 函数命名: 首字母小写驼峰式命名. 如i

24、TaoLun();6. 命名语义化, 尽可能利用英文单词或其缩写;7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval() & innerText;8. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;9. 代码结构明了, 加适量注释. 提高函数重用率;10. 注重与html分离, 减小reflow, 注重性能.2.6 图片规范使用场景：引用添加图片文件时，根据此规则对图片格式进行选择以及命名存放。1. 所有页面元素类图片均放入images文件夹, 测试用图片放于images/demoimg文件夹;2. 图片格式仅限于

25、gif | png | jpg;3. 命名全部用小写英文字母 | 数字 | _ 的组合，其中不得包含汉字 | 空格 | 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif | btn_submit.gif;4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间;5. 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明);6. 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至images目

26、录下.2.7 注释规范使用场景：书写代码时，根据此规则对代码进行适当注释说明，方便自己或他人阅读和理解。2.7.1 html注释注释格式 , -只能在注释的始末位置,不可置入注释文字区域。2.7.2 css注释1. 行间注释：直接写于属性值后面。例： .search border:1pxsolid#fff;/*定义搜索输入框边框*/ background:url(./images/icon.gif)no-report#333;/*定义搜索框的背景*/ 2. 整段注释：分别在开始及结束地方加入注释。例： /*=搜索条=*/ .search border:1pxsolid#fff;background:url(./images/icon.gif)no-repeat#333; /*=搜索条结束=*/2.7.3 JavaScript注释JavaScript注释, 单行注释使用/这儿是单行注释 ,多行注释使用 /* 这儿有多行注释 */;四、执行模式 规范文档存入部门SVN文件库，方便下载查阅。 根据规范内容，制作网页格式帮助手册。 根据规则建立和不断完善框架模板库，给不同类型的网站提供示例参考。 执行规范过程中根据实际情况不断补充完善规则。 开发负责人需要检查提交的代码是否符合规范，并记录检查结果。