html 编码规范

最新推荐文章于 2024-07-29 09:00:00 发布

遗失的小许

最新推荐文章于 2024-07-29 09:00:00 发布

阅读量593

点赞数

分类专栏： html javascript

html 同时被 2 个专栏收录

38 篇文章 0 订阅

订阅专栏

javascript

18 篇文章 0 订阅

订阅专栏

转自：

　　http://blog.csdn.net/hongdi/article/details/7065380

一、javascript编码规范

1．所有js代码应写在一个.js文件中，使用<scripttype=“text/javascript” src=“xxx.js”></script>引入，不在html文件中直接写js代码

2．<script>标签的language属性已废弃，不要再使用

3．所有变量使用前必须声明，声明变量需要使用var关键字，否则默认声明的为全局变量，变量名应为英文字母，数字，下划线“_”，美元符号“$”组成，变量名第一个字符不能是数字。

4．变量名统一使用小写字母，多个单词时使用驼峰式命名，即后面的单词首字母大写

如：userName = “xxx”;。

5．常量名应全为大写，单词与单词之间使用下划线“_”连接，如：PAGE_SIZE=“20”;。

6．代码中不要直接使用数字，而是事先将数字保存至一个变量或常量中，这样更便于理解，如：var RELOAD_DELAY=“3000”。

7．每行语句结束时必须使用分号“;”结束，这样能提高解析的速度，同时能避免代码压缩时出错。

8．一行语句的字符数不能太长，一般不超过80个字符，多出的应该换行显示。

9．函数命名一般以模块名如：“news_”加上功能描述，如：news_showDetail();

10．声明数组直接使用var newArray = []; 替代var newArray=newArray();，声明对象直接使用var obj = {}替代varobj=new Object();;

11．代码缩进，统一缩进四个空格，不要使用软件自带的Tab键，因为每个软件的Tab键的缩进可能会不一致，如果需要使用，应将软件的Tab键设置为四个空格

12．代码书写格式

if(….){

... …

}else{

... …

}

function fun(){

… …

}

其它建议

13．注释，分为行注释和块注释，根据需要选择。代码中应该合理使用注释，一般较复杂的功能性函数都需要注释说明作用及用途，以便阅读和维护。

14．自定义类首字母大写，与javascript内置对象保持一致。

15．不要使用document.all来判断IE浏览器，应使用其它替代，如：window.attachEvent。

16．尽量不要使用eval()函数，因为eval()涉及安全问题，如代码注入。

17．所有对象的最后一项不要加逗号“,”,避免IE6中不识别出错。

18．编码完后可以使用检查工具检查代码：JSLint (http://www.jslint.com/)

二．HTML编码规范

1．所有HTML页面必须包含<!DOCTYPE>，并放在文件第一行，

<!DOCTYPE HTML PUBLIC "-//W3C//DTDHTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

2．代码书写严格参照xhtml规范，标签必须全是小写，所有标签都要关闭，即有开始和结束标签，包括单个的标签<br>等。

<div>…</div> 标签成对出现

单个的标签应该使用“/”自关闭，“/”前必须有一个空格。如：

<hr />

<br />

3．属性全都使用小写，所有属性需要有属性值，属性值必须使用引号（一般为双引号）括起，没有属性值的应该像这样写：disabled=“disabled”。

4．一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记除外)，

错误写法：

正确写法：

<tr>

<tr>

5．不得出现交叉包含的语句，如：

6．图片都要加alt属性，alt的值最好与图片相关的，如果没有的话也要写上空的alt=“”。

7．文件名后缀应统一是html，而不使用htm。

8．标签缩进统一为四个空格，使用Tab键需要设置软件的Tab键缩进4个空格。

9．语义化标签，尽量使用html含样式标签替代div,span,p等无意义的标签，使用h1-h6作页面的标题，使用ul，ol，dl作列表。

原始写法：

</div>

改进写法：（这时就算将全部的css去掉也能显示成列表布局）

</ul>

10．标签的命名，多个单词使用中划线分隔，因为中划线会将长ID拆分为独立的单词，而下划线则将长ID显示成一个单词，中划线利于搜索引擎搜索。

11．不使用已经废弃的标签，如<center>等。

12．尽量不要使用colspan，rowspan两个属性，会引起兼容性问题。

13．页面中尽量少使用table，使用div，span等标签替代，使结构与样式分离。

三．CSS编码规范

1．所有的css代码都写到一个css文件中，使用<linkrel="stylesheet" type="text/css" href="xxx.css"/>引入到页面中。

2．书写格式，当属性值超过1个时，应当把每个属性值独占一行。如下所示：

.header {width:1000px;}

.header {

width:1000px;

height:100px;

border:1px solid#9c9c9c;

}

3．使用简写

如：

font-style:italic;

font-weight:bold;

font-size:14px;

line-height:18px;

简写成：

font:italic bold 14px/18px;

4．命名应该有意义，尽量不要使用缩写，除非一看就明白或特别长的单词。

5．使用驼峰式命名方式，如：productDetail

6．A标签伪类书写要严格按照a:link，a:visited，a:hover，a:active的顺序，否则在某些浏览器中会失效。

提示：在CSS定义中，a:hover必须被置于a:link和a:visited之后，才是有效的。

提示：在CSS定义中，a:active必须被置于a:hover之后，才是有效的。

7．设置颜色时统一使用十六进制的颜色单位，使用color:#FF0000替代color:red。

8．全部使用小写，所有属性值都应该用引号括起来，属性值有单位的全部要加上单位。

9．格式化标签的默认样式，如：body，h1-h6，p，ul，li等(因为每个浏览器对html标签样式解析是不一致的，需要将所有浏览器统一)

10．body元素要设置background-color属性，比如当body背景色使用白色时，虽然默认是白色，但还是应该显式的声明background-color:“#ffffff”;这样可以避免用户将默认值修改后引起兼容性问题。

11．CSS Hack是当某个浏览器或版本中的实际表现与需要的样式不一致时的补救方法，出现这种问题的原因可能是浏览器对某个样式不支持，也有可能是自身的css代码不标准，CSS Hack只是一种补救方法，出现问题时，应该先检查自己的代码是符合标准。再考虑使用Hack，能不用时尽量不用。

以上大部分是根据自己实际工作中遇到的总结而来的，部分来自网络，还有很多没有考虑到，欢迎大家补充，拍砖。。

//==============================另外一个=================================================

WEB前端开发规范文档[转]

　　为新项目写的一份规范文档, 分享给大家. 我想前端开发过程中, 无论是团队开发, 还是单兵做站, 有一份开发文档做规范, 对开发工作都是很有益的. 本文档由本人编写, 部分意见来源于网络, 以此感谢, 片面及有误的地方, 希望大家指正. 另, 本文档部分规范是为我所在项目组所写, 使用时请根据实际项目需求修改.
以下为[WEB前端开发规范文档]正文点此查看WEB版本

规范目的

　　为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.

基本准则

　　符合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文件时, 须略去默认类型声明, 写法如下:

　　　　<link rel=”stylesheet” href=”…” />

　　　　<style>…</style>

　　　　<script src=”…”></script>

　　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>完全可以用以下代码替代: <div class=”box”><p>欢迎访问XXX, 您的用户名是<span>用户名</span></p></div>;

　　9. 书写链接地址时, 必须避免重定向，例如：href=”http://itaolun.com/”, 即须在URL地址后面加上“/”；

　　10. 在页面中尽量避免使用style属性,即style=”…”;

　　11. 必须为含有描述性表单元素(input, textarea)添加label, 如<p>姓名: <input type=”text” id=”name” name=”name” /></p>须写成:<p><label for=”name”>姓名: </label><input type=”text” id=”name” /></p>

　　12. 能以背景形式呈现的图片, 尽量写入css样式中;

　　13. 重要图片必须加上alt属性; 给重要的元素和截断的元素加上title;

　　14. 给区块代码及重要功能(比如循环)加上注释, 方便后台添加功能;

　　15. 特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(>) & 空格( ) & »(») 等等;

　　16. 书写页面过程中, 请考虑向后扩展性;

　　17. class & id 参见 css书写规范.

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中已建好框架的页面, 如, 要在2中已建好框架的页面代码<div id=”mainnav”></div>中加入新的div元素,

　　　　按a命名法则: <div id=”mainnav”><div class=”firstnav”>…</div></div>,

　　　　样式写法: #mainnav .firstnav{…….}

　　　　按b命名法则: <div id=”mainnav”><div class=”main_firstnav”>…</div></div>,

　　　　样式写法: .main_firstnav{…….}

　　7. css属性书写顺序, 建议遵循: 布局定位属性–>自身属性–>文本属性–>其他属性. 此条可根据自身习惯书写, 但尽量保证同类属性写在一起. 属性列举: 布局定位属性主要包括: display & list-style & position（相应的 top,right,bottom,left）＆ float & clear ＆ visibility ＆ overflow；自身属性主要包括: width & height & margin & padding & border & background; 文本属性主要包括：color & font & text-decoration & text-align & vertical-align & white-space & 其他 & content; 我所列出的这些属性只是最常用到的, 并不代表全部;

　　8. 书写代码前, 考虑并提高样式重复使用率;

　　9. 充分利用html自身属性及样式继承原理减少代码量, 比如:

　　　　<ul class=”list”><li>这儿是标题列表<span>2010-09-15</span></ul>

　　　　定义

　　　　ul.list li{position:relative} ul.list li span{position:absolute; right:0}

　　　　即可实现日期居右显示

　　10. 样式表中中文字体名, 请务必转码成unicode码, 以避免编码错误时乱码;

　　11. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;

　　12. 使用table标签时(尽量避免使用table标签), 请不要用width/ height/cellspacing/cellpadding等table属性直接定义表现, 应尽可能的利用table自身私有属性分离结构与表现, 如thead,tr,th,td,tbody,tfoot,colgroup,scope; (cellspaing及cellpadding的css控制方法: table{border:0;margin:0;border-collapse:collapse;} table th, table td{padding:0;}, base.css文件中我会初始化表格样式)

　　13. 杜绝使用<meta http-equiv=”X-UA-Compatible” content=”IE=7″ /> 兼容ie8;

　　14. 用png图片做图片时, 要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果, 请为ie6单独定义背景:

_background:none;_filter:progid:DXImageTransform.Microsoft.AlphaImageLoader(sizingMethod=crop, src=’img/bg.png’);

　　15. 避免兼容性属性的使用, 比如text-shadow || css3的相关属性;

　　16. 减少使用影响性能的属性, 比如position:absolute || float ;

　　17. 必须为大区块样式添加注释, 小区块适量注释;

　　18. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化i会统一处理;

JavaScript书写规范

　　1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || …);

　　2. 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;

　　3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;

　　jQuery变量要求首字符为’_', 其他与原生JavaScript 规则相同, 如: _iTaoLun;另, 要求变量集中声明, 避免全局变量.