1、Web前端开发规范手册1Web 前端开发规范手册目录修订历史记录.错误！未定义书签。一、规范目的.21.1 概述.2二、基本准则.2三、文件规范.22.1 文件命名规则.22.1.1 HTML 的命名原则.32.1.2 图片的命名原则.32.1.3. javascript 的命名原则.32.1.4 动态语言文件命名原则. 32.2 文件存放位置规范.42.3 CSS 书写规范.42.3.1 基本原则.42.3.2 注意细则.52.3.3 命名规则.62.4 html 书写规范.92.4.1 head 区代码规范.92.4.2 body 区代码规范.102.5 JavaScript 书写规范.1
2、0Web前端开发规范手册22.6 图片规范.102.7 注释规范.112.7.1 html 注释.112.7.2 css 注释.112.7.3 JavaScript 注释.11四、执行模式.11一、规范目的1.1 概述 提高团队协作效率 便于前端开发以及后期优化维护 方便新进的成员快速上手 输出高质量的代码本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出，经讨论决定后可以更新此文档。二、基本准则 符合 web 标准, 语义化 html, 结构表现行为分离, 兼容性优良。 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析
3、速度。开发时需要遵循如上基本准则，特殊情况可以有所宽限，如一些老项目的页面改造。三、文件规范2.1 文件命名规则使用场景：在新建网页、图片、脚本、CSS 文件时，根据此规则给文件命名并放入指定位置 文件名称统一用小写的英文字母、数字和下划线的组合，其中不得包含汉字空格和特殊字符。命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文Web前端开发规范手册3件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。2.1.1 HTML 的命名原则索引文件统一使用 index.htm index.ht
4、ml index.asp 文件名。各子页命名的原则首先应该以栏目名的英语翻译取单一单词为名称。例如：子页 命名关于我们 aboutus信息反馈 feedback产 品 product如果栏目名称多而复杂并不好以英文单词命名，则统一使用该栏目名称拼音或拼音的首字母表示。每一个目录中应该包含一个缺省的 html 文件，文件名统一用 index.htm index.htmlindex.asp。2.1.2 图片的命名原则图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质。例如：广告、标志、菜单、按钮等等。 放置在页面顶部的广告、装饰图案等长方形的图片取名： banner 标志性的图片取
5、名为： logo 在页面上位置不固定并且带有链接的小图片我们取名为 button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名： menu 装饰用的照片我们取名： pic 不带链接表示标题的图片我们取名： title范 例 ： banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.giftitle_news.gif logo_police.gif logo_national.gif pic_people.jpg2.1.3. javascript 的命名原则一般使用脚本功能的英文小写缩写命名。例如：广告条的 javas
6、cript 文件名为 ad.js 弹出窗口的 javascript 文件名为 pop.js2.1.4 动态语言文件命名原则以性质_描述，描述可以有多个单词，用“_”隔开，性质一般是该页面得概要。Web前端开发规范手册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
7、 书写规范使用场景：书写 CSS 样式时，根据此规则对 id 和 class 进行命名，并遵循书写规则，避免出现常犯错误，提高效率。2.3.1 基本原则CSS 样式可细分为 3 类：重新定义 HTML 样式、链接状态样式、自定义样式。1. 重新定义 HTML 样式为设计师重新定义已有的 HTML 标签样式，影响全部的被设定标签样式，用于统一网页中某一标签的样式定义。样式名“HTML 标签”例：hr border: 1pxdotted #333333 2. 链接状态样式为设计师对链接不同状态设定特殊样式，影响被使用本样式区域中的链接。该样式写法有 2 种： a.nav:link(中间无空格) 、
8、.nav a:link 第一种只能修饰标签中；第二种可以修饰所有包含有标签的其他标签。3. 样式为设计师自定义的新 CSS 样式，影响被使用本样式的区域，用于完成网页中局部的样式设定。样式名 “.”+“相应样式效果描述的单词或缩写”例：“ .shadow ”文字样式样式名“.no”+“字号”+“行距”+“颜色缩写”例：“ .no12 ” 、“ .no12_24 ”“.no12”类型一般出现在 base.css 文件中，只可选用，不可修改，避免名称含义和实际内容不符。自定义的样式名最好用意义命名。比如：重要的新闻高亮显示（像红色），有两种写法：redcolor:red；.important_ne
9、wscolor:red；很显然第二种传达的意义更加明确,所以尽量不要用意义不明确的作为自定义命名。4. 页面内的样式加载必须用链接方式：5. 重新定义的最先，伪类其次，自定义样式最后，便于自己和他人阅读。Web前端开发规范手册56. 一般不允许将样式的定义写在标签中（如：style=“color:red;”）；7. 所有装饰性的图片（如背景图），要定义在 CSS 中；2.3.2 注意细则1. class与id命名: 大的框架命名比如header/footer/wrapper/left/right之类的由设计框架之人统一命名。其他样式名称由小写英文 总之, 命名要语义化, 简明化。2. 规避 c
10、lass 与 id 重名 , 不建议使用 id 选择器。a. 通过从属写法规避, 示例见 d;b. 取父级元素 id/class 命名部分命名, 示例见 d;c. 重复使用率高的命名,可加代号加下划线起始, 比如 i_clear;d. a、b 两条, 适用于在 2 中已建好框架的页面, 如, 要在 2 中已建好框架的页面代码中加入新的 div 元素,按 a 命名法则: .,样式写法: #mainnav .firstnav.按 b 命名法则: .,样式写法: .main_firstnav.3. css 属性书写顺序, 建议遵循 布局定位属性自身属性文本属性其他属性。此条可根据自身习惯书写, 但尽
11、量保证同类属性写在一起。文件夹 说明布局定位属性 Marginpaddingfloatclearposition （ 相 应 的top,right,bottom,left）displayvisibilityoverflow 等自身属性 Widthheightbackground border文本属性 fontcolortext-aligntext-decorationtext-indent white-spaceothertextcontent 等其他属性 list-style(列表样式)vertical-aligncursorz-index(层叠顺序)zoom 等4. 书写代码前, 考虑并提
12、高样式重复使用率;5. 杜绝使用 兼容 ie8;6. 避免兼容性属性的使用, 比如 text-shadow | css3 的相关属性;7. 减少使用影响性能的属性, 比如 position:absolute | float ;8. 重要图片加上 alt 属性；重要的元素和截断的元素加上 title;9. 避免使用!important，!important 的优先级最高;10. 必须为大区块样式添加注释, 小区块适量注释;11. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化统一处理;12. Margin、padding、border、font 等样式尽可能采用合并写法;Web前端
13、开发规范手册6上面的简写图解说明的是依据不同的属性值可以进行不同的缩写，这种方法同样适用于padding 和 Border-width 属性;Font 的简写对于缩小代码量很有帮劣，如果没有定义某个属性值的话，将继承父级元素的定义或使用默认值。2.3.3 命名规则页面结构容器: container/wrap 整体宽度：wrapper页头：header 内容：content页面主体：main 页尾：footer侧栏：sidebar 栏目：column中间内容：center导航导航：nav 主导航：mainbav/globalnav子导航：subnav 顶导航：topnav边导航：sidebar
14、左导航：leftsidebar右导航：rightsidebar 边导航图标：sidebarIcon菜单：menu 子菜单：submenuWeb前端开发规范手册7标题: title功能标志：logo 登陆：login登录条：loginbar 注册：regsiter产品：products 产品价格：products_prices产品评论：products_review 编辑评论：editor_review最新产品：news_release 最新产品：news_release广告/标语：banner 摘要:summary生产商：publisher 缩略图：screenshot常见问题：faqs 关键
15、词：keyword博客：blog 论坛：forum搜索：search 搜索输入框：search_input搜索输出：search_output 搜索结果：search_results加入我们：joinus 状态：status按钮：btn 滚动：scroll标签页：tab 文章列表：list提示信息：msg/message 当前的: current小技巧：tips 皮肤：skin充值：pay 活动：activities推广：promotion 公告：announcement排行：ranking 公司简介：company_profile公司设备：equipment 公司荣誉：glories企业文化
16、：culture 企业规模：scale营销网络：sales_network 组织机构：organization技术力量：technology 分支机构：branches企业资质：enterprise_qualification 公司实力：strength_strength经营理念：operation_principle 经理致辞：manager_oration发展历程：development_history 工程案例：engineering_projects分类浏览：browse_by_category 应用领域：application_fields人力资源：human_resource_hr
17、 领导致辞： leader_oration客户留言：customer_message 客户服务：customer_service您的要求：your_requirements 销售信息：sales_information招商：enterprise_establishing 教育培训：education_training在线交流：online_communication 质量认证：quality_certification合作加盟：joinIn_cooperation 产品描述：products_description业务范围：business_scope 产品销售：sales_sales联系我们
18、：contact_us 信息发布：informationWeb前端开发规范手册8返回首页：homepage 产品定购：order电子商务：e_business 版权所有：copy _right友情连结：hot_link 行业新闻：trade_news行业动态：trends 邮编：postal_code_zipcode新闻动态：news_trends 公司名称：company_name销售热线：sales_hotline 联系人：contact_person建设中：in_construction 证书：certificate地址：add 电话：tel传真：fax 产品名称：product_nam
19、e产品说明：description 价格：price品牌：brand 规格：specification尺寸：size 生产厂家：manufacuturer型号：model 产品标号：item_no技术指标：technique_data 产品描述：description产地：production_place 用途：application论坛：forum 在线订购：on_line_order招标：bidInviting 综述：general业绩：achievements 大事：great_event动态：trends 服务：service投资：investment 行业：industry规划：pr
20、ogramming 环境：environment发送：delivery 提交：submit重写：reset 社区：community业务：business 在线调查：online_inquiry下载中心：download 意见反馈：feedback常见问题：faq 中心概况：general_profile游乐园：amusement_park 专题报道：special_report图标: icon 注释：note指南：guild 服务：service热点：hot 新闻：news下载：download 投票：vote商标：label/branding 当前位置：breadcrumb/loc购物车：
21、shop 标签：tag信誉：siteinfo_credits 网站信息：siteinfo法律声明：siteinfo_legal 合作伙伴：partner友情链接：friendlink 版权：copyrightWeb前端开发规范手册92.4 html 书写规范使用场景：书写 html 页面时，根据此规则对 html 内容进行补充和完善。2.4.1 head 区代码规范head 区是指 HTML 代码的和之间的内容。 必须加入的标签1. 网页显示字符集简体中文：繁体中文：英 语：2. 搜索关键字（网站类型）3. 网页的 css 规范 4. 网页标题 xxxxxxxxxxxxxxxxxx 可以选择加
22、入的标签1.公司版权注释2. 网页制作者信息3. 网站简介4. 设定网页的到期时间。一旦网页过期，必须到服务器上重新调阅。5. 禁止浏览器从本地机的缓存中调阅页面内容。6. 用来防止别人在框架里调用你的页面。7. 自动跳转。5 指时间停留 5 秒8. 网页搜索机器人向导。用来告诉搜索机器人哪些页面需要索引，哪些页面不需要索引。CONTENT 的参数有 all,none,index,noindex,follow,nofollow。默认是 all。9. 收藏夹图标 10. 所有的 javascript 的调用尽量采取外部调用.Web前端开发规范手册102.4.2 body 区代码规范1. 附标签：
23、标签不属于 head 区，这里强调一下，为了保证浏览器的兼容性，必须设置页面背景（此处为示意，样式需写在 CSS 文件中）2. 在浏览器里，当我们点击空链接时，它会自动将当前页面重置到首端，从而影响用户正常的阅读内容，我们用代码“javascript:void(null)”代替原来的“#”标记。链接2.5 JavaScript 书写规范使用场景：书写 js 脚本时，根据此规则对变类、函数、变量命名，并遵循书写规则，避免出现常犯错误，提高脚本效率。1. 书写过程中, 每行代码结束必须有分号; 原则上所有功能均根据 XXX 项目需求原生开发,以避免网上 down 下来的代码造成的代码污染(沉冗代码
24、 | 与现有代码冲突 | .);2. 库引入: 原则上仅引入 jQuery 库,以及组件组开发的相关库。 若需引入第三方库, 须与团队其他人员讨论决定;3. 变量命名: 驼峰式命名. 原生 JavaScript 变量要求是纯英文字母, 首字母须小写, 如iTaoLun; jQuery 私 有 变 量 要 求 首 字 符 为 _, 其 他 与 原 生 JavaScript 规 则 相 同 , 如 :_iTaoLun; 另, 要求变量集中声明, 避免全局变量.4. 类命名: 首字母大写，如 ITaoLun;5. 函数命名: 首字母小写驼峰式命名. 如 iTaoLun();6. 命名语义化, 尽可能
25、利用英文单词或其缩写;7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如 eval() 8. 后期优化中, JavaScript 非注释类中文字符须转换成 unicode 编码使用, 以避免编码错误时乱码显示;9. 代码结构明了, 加适量注释. 提高函数重用率;10. 注重与 html 分离, 减小 reflow, 注重性能.2.6 图片规范使用场景：引用添加图片文件时，根据此规则对图片格式进行选择以及命名存放。1. 所有页面元素类图片均放入 images 文件夹, 测试用图片放于 images/demoimg 文件夹;2. 图片格式仅限于 gif | png | jpg;3. 命名全部用小写英文字母 | 数字 | _ 的组合，其中不得包含汉字 | 空格 | 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解; 另, 命名分头尾两部分, 用下划线隔开, 比如
