基本准则
符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面,
代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.
html书写规范
-
文档类型声明及编码: 统一为html5声明类型<!DOCTYPE html>;
编码统一为<meta charset=”gbk” />, 书写时利用IDE实现层次分明的缩进; -
非特殊情况下样式文件必须外链至<head>…</head>之间;
非特殊情况下JavaScript文件必须外链至页面底部; -
引入样式文件或JavaScript文件时, 须略去默认类型声明, 写法如下:
<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><div class=”welcome”>欢迎访问XXX, 您的用户名是<div class=”name”>用户名</div></div></div>
完全可以用以下代码替代:
<div><p>欢迎访问XXX, 您的用户名是<span>用户名</span></p></div>; -
书写链接地址时, 必须避免重定向，例如：href=”[http://taobao.com/)”, 即须在URL地址后面加上“/”；
-
在页面中尽量避免使用style属性,即style=”…”;
-
必须为含有描述性表单元素(input, textarea)添加label, 如<p>姓名: <input type=”text” id=”name” name=”name” /></p>须写成:<p><label for=”name”>姓名: </label><input type=”text” id=”name” /></p>
-
能以背景形式呈现的图片, 尽量写入css样式中;
-
重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;
-
给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;
-
特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(>) & 空格( ) & »(») 等等;
-
书写页面过程中, 请考虑向后扩展性;
-
class & id 参见 css书写规范.
css书写规范
-
编码统一为utf-8;
-
协作开发及分工: i会根据各个模块, 同时根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构&表现&行为; 共用css文件base.css由i书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件不可随意修改;
-
class与id的使用: id是唯一的并是父级的, class是可以重复的并是子级的, 所以id仅使用在大的模块上, class可用在重复使用率高及子级中; id原则上都是由分发框架文件时命名的（如#header #footer #content #nav 等）, 为JavaScript预留钩子的除外;
-
为JavaScript预留钩子的命名, 请以 js_ 起始, 比如: js_hide, js_show(淘宝是用的J_开头);
-
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=”mainnav”><div>…</div></div>,
样式写法: #mainnav .firstnav{…….}
按b命名法则: <div id=”mainnav”><div>…</div></div>,
样式写法: .main_firstnav{…….}
网友评论