从目的上讲，规范与文档都是为了降低团队的协作成本和维护成本，提高开发效率和质量，保证不会因为开发人员的变动而产生较大的影响。

随着前端的发展，文档已经慢慢的变得不可或缺了，并由社区的努力而形成了 JSDoc ，类似 JavaDoc 和 PHPDoc。

JSDoc 是一个根据 javascript 文件中注释信息，生成 JavaScript 应用程序或库、模块的 API 文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等，并且很多编辑器和 IDE 都是直接支持智能提示的。

JSDoc 注释一般应该放置在方法或函数声明之前，它必须以 /** 开始，其他任何以 /* ， /*** 或者超过3个星号的注释，都将被JSDoc解析器忽略。例如：

另外一个需要记录的信息就是业务逻辑、更新日志与备注。

有些比较复杂的业务逻辑不太适合放在注释里面，需要单独写逻辑文档，以备后面查看。

有时候，有些逻辑并不是简单的用文字描述就能说的清楚的，还需要图表或者思维导图的辅助。

更新日志也是一个比较重要文档，能够方便查找更新状态、时间、开发人员等。

如果有额外的一些信息，需要用文档备注一下。

上一篇： 前端开发规范

下一篇： 构建工具 for teamwork

参考文章：

更多博客，查看 https://github.com/senntyou/blogs

规范目的

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

基本准则

符合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声明类型编码统一为, 书写时利用IDE实现层次分明的缩进

2. 非特殊情况下样式文件必须外链至…之间非特殊情况下JavaScript文件必须外链至页面底部

3. 引入样式文件或JavaScript文件时, 须略去默认类型声明.

4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.7.1.min.js引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js

5. 所有编码均遵循xhtml标准, 标签 &属性 &属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合属性值必须用双引号包括

6. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性，避免使用”data:”等其他命名方式

7. 语义化html, 如 标题根据重要性用h(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素

8. 尽可能减少div嵌套

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

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

11. 必须为含有描述性表单元素(input, textarea)添加label

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元素

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自身属性及样式继承原理减少代码量, 比如:这儿是标题列表2012-04- 24

定义

ul.list li{position:relative} ul.list li span{position:absoluteright: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:0margin:0border-collapse:collapse} table th, table td{padding:0}, base.css文件中我会初始化表格样式)

13. 如何可以请少使用兼容

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. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化会统一处理

JavaScript书写规范

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

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

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

jQuery变量要求首字符为’_’, 其他与原生JavaScript 规则相同, 如: _iTaoLun

另, 要求变量集中声明, 避免全局变量.

4. 类命名: 首字母大写, 驼峰式命名. 如 ITaoLun

5. 函数命名: 首字母小写驼峰式命名. 如iTaoLun()

6. 命名语义化, 尽可能利用英文单词或其缩写

7. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval_r() &innerText

8. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示

9. 代码结构明了, 加适量注释. 提高函数重用率

10. 注重与html分离, 减小reflow, 注重性能.

图片规范

1. 所有页面元素类图片均放入img文件夹, 测试用图片放于img/demoimg文件夹

2. 图片格式仅限于gif || png || jpg

3. 命名全部用小写英文字母 || 数字 || _ 的组合，其中不得包含汉字 || 空格 || 特殊字符；尽量用易懂的词汇, 便于团队其他成员理解另, 命名分头尾两部分, 用下划线隔开, 比如ad_left01.gif || btn_submit.gif

4. 在保证视觉效果的情况下选择最小的图片格式与图片质量, 以减少加载时间

5. 尽量避免使用半透明的png图片(若使用, 请参考css规范相关说明)

6. 运用css sprite技术集中小的背景图或图标, 减小页面http请求, 但注意, 请务必在对应的sprite psd源图中划参考线, 并保存至img目录下.

注释规范

1. html注释: 注释格式 , ‘–’只能在注释的始末位置,不可置入注释文字区域

2. css注释: 注释格式

3. JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用

开发及测试工具约定

建议使用WebStorm||Aptana || Dw || Vim , 亦可根据自己喜好选择, 但须遵循如下原则:

1. 不可利用IDE的视图模式’画’代码

2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js

3. 编码必须格式化, 比如缩进

测试工具: 前期开发仅测试FireFox &IE6 &IE7 &IE8 &IE9 &Opera &Chrome &Safari

其他规范

1. 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发

2. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.

百度解释：

指掌控权利的一方，例如公司的“官方”，“官网”则是官方网站。另外也指，某一方说的什么都是有理由的，没有不对的地方。官方是指举办某场社会活动事件的组织者，或某种商业产品的推广经营者，即主办方，是一个直接面对消费者的团体组织或企业。主办方具有权威性，有着制定力。简而言之，官方也就是对于某指定生产商品有着最大解释权和定义权，对于该商品来说，官方信息也是最具权威、正确的信息。现代商业中，企业以广告赞助的方式，取得某场活动的指定消费品，例如：官方用车，官方指定饮料等，以达到品牌推广及销售的目的。

我个人：

比如HTML5：超文本标记语言，是万维网联盟规范，那么万维网联盟就是属于HTML5的官方了，那么他的对HTML描述的文档就是官方文档

比如jQeury：jQuery在2006年1月由美国人John Resig在纽约的barcamp发布，吸引了来自世界各地的众多JavaScript高手加入，由Dave Methvin率领团队进行开发。现在官方网址“jqueryxxx”（这里不写完整，因为“知道”不允许），那么开发jQuery的团队自己定义的文档就是“官方文档”。