Web前端开发规范.docVIP

Web前端开发规范 应用指南 版本1.0 郑州蜂鸟科技有限公司 周源 郑州软件开发兴趣小组群 目录 规范目的 3 1.1 概述 3 二、 文件规范 3 1.1 基本准则 3 1.2 文件规范 3 1.3 html书写规范 3 1.4 css书写规范 4 1.5 JavaScript书写规范 6 1.6 图片规范 6 1.7 注释规范 6 1.8 开发及测试工具约定 7 1.9 其他规范 7 三、 文档说明 7  规范目的 1.1 概述 link rel=stylesheet href=... / style.../style script src=.../script; 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js; 所有编码均遵循xhtml标准, 标签 属性 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (br /), hr(hr /)等; 属性值必须用双引号包括; 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以data-为前缀来添加自定义属性，避免使用data:等其他命名方式; 语义化html, 如 标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素; 尽可能减少div嵌套, 如div class=boxdiv class=welcome欢迎访问XXX, 您的用户名是div class=name用户名/div/div/div完全可以用以下代码替代: div class=boxp欢迎访问XXX, 您的用户名是span用户名/span/p/div; 在页面中尽量避免使用style属性,即style=…; 必须为含有描述性表单元素(input, textarea)添加label, 如p姓名: input type=text id=name name=name //p须写成:plabel for=name姓名: /labelinput type=text id=name //p 能以背景形式呈现的图片, 尽量写入css样式中; 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title; 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能; 特殊符号使用: 尽可能使用代码替代: 比如 () (gt;) 空格( ) ?(?) 等等; 书写页面过程中, 请考虑向后扩展性; class id 参见 css书写规范. css书写规范 编码统一为utf-8; 协作开发及分工: i会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构表现行为; 共用css文件base.css由i书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改; class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中; id原则上都是由我分发框架文件时命名的, 为JavaScript预留钩子的除外; 为JavaScript预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show; class与id命名: 大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式名称由 小写英文 数字 _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化. 规避class与id命名(此条重要, 若有不明白请及时与i沟通): a, 通过从属写法规避, 示例见d; b, 取父级元素id/class命名部分命名, 示例见d; c, 重复使用率高的命名, 请以自己代号加下划线起始, 比如i_clear; d, a,b两条, 适用于在2中已建好框架的页面, 如, 要在2中已建好框架的页面代码div id=mainnav/div中加入新的div元素, 按a命名法则: div id=mainnavdiv class=firstnav.../div/div, 样式写法: #mainnav .firstnav