基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的 解析速度.
文件规范 1. html, css, js, images文件均归档至<系统开发规范>约定的目录中; 2. html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加 功能时查找对应页面; 3. css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.; 4. Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名.
html书写规范 1. 文档类型声明及编码: 统一为html5声明类型<!DOCTYPE html>; 编码统一为<meta charset="gbk" />, 书写时利用IDE实现层 次分明的缩进; 2. 非特殊情况下样式文件必须外链至<head>...</head>之间;非特殊情况下JavaScript文件必须外链至页面底部; 3. 引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下:
4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比 如jQuery.cookie.js; 5. 所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括 br (<br />), hr(<hr />)等; 属性值必须用双引号包括; 6. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html 元素添加自定义属性的时候, 首先 要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以"data-"为前缀来添加自定义属性,避免 使用"data:"等其他命名方式; 7. 语义化html, 如 标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素; 8. 尽可能减少div嵌套, 如<div class="box"><div class="welcome">欢迎访问 XXX, 您的用 户名是<div class="name">用户名</div></div></div& gt;完全可以用以下代码替代: <div class="box"><p>欢迎 访问XXX, 您的用户名是< span>用户名</span></p></div>; 9. 书写链接地址时, 必须避免重定向,例如:href="http://itaolun.com/", 即须在URL地址后面加上“/”; 10. 在页面中尽量避免使用style属性,即style="…"; 11. 必须为含有描述性表单元素(input, textarea)添加label,.
css书写规范 1. 编码统一为utf-8; 2. 协作开发及分工: i会根据各个模 块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构&表现&行为; 共用css文件base.css 由i书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改; 3. class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级 中; id原则上都是由我分发框架文件时命名的, 为JavaScript预留钩子的除外; 4. 为JavaScript预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show; 5. class与id命名: 大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样 式名称由 小写英文 & 数 字 & _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文 拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明 化. 6. 规避class与id命名(此条重要, 若有不明白请及时与i沟通): a, 通过从属写法规避, 示例见d; b, 取父级元素id/class命名部分命名, 示例见d; c, 重复使用率高的命名, 请以自己代号加下划线起始, 比如i_clear; d, a,b两条, 适用于在2中已建好框架的页面,. |