Web前端开发规范文档

coollrzx 2018-08-13

展开全文

Web前端开发规范文档

规范目的：

使开发流程更加规范化。

通用规范：

TAB键用两个空格代替（WINDOWS下TAB键占四个空格，LINUX下TAB键占八个空格）。
CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。
文件内容编码均统一为UTF-8。
CSS、JAVASCRIPT中的非注释类中文字符须转换成unicode编码使用,
以避免编码错误时乱码显示。

文件规范：

文件名用英文单词，多个单词用驼峰命名法。
一些浏览器会将含有这些词的作为广告拦截，文件命名、ID、CLASS等所有命名避免以上词汇。
``` ad、ads、adv、banner、sponsor、gg、guangg、guanggao等

html书写规范：

为每个HTML页面的第一行添加标准模式（standard
mode）的声明，确保在每个浏览器中拥有一致的展现。
文档类型声明统一为HTML5声明类型，编码统一为UTF-8。
中添加信息。
IE支持通过特定标签来确定绘制当前页面所应该采用的IE版本。除非有强烈的特殊需求，否则最好是设置为edge
mode ，从而通知IE采用其所支持的最新的模式。
非特殊情况下CSS样式文件外链至HEAD之间，JAVASCRIPT文件外链至页面底部。
引入JAVASCRIPT库文件，文件名须包含库名称及版本号及是否为压缩版。
引入JAVASCRIPT插件, 文件名格式为库名称+.+插件名称。
HTML属性应当按照以下给出的顺序依次排列，来确保代码的易读性。
编码均遵循XHTML标准,
标签、属性、属性命名由小写英文、数字和_组成，且所有标签必须闭合，属性值必须用双引号'',
避免使用中文拼音尽量简易并要求语义化。
当JAVASCRIPT获取单个元素时，通常使用document.getElementById来获取dom元素，document.getElementById兼容所有浏览器，但IE浏览器会混淆元素的ID和NAME属性，所以要区分ID和NAME命名。
特殊符号应使用转意符。
含有描述性表单元素（INPUT，TEXTAREA）添加LABEL。
多用无兼容性问题的HTML内置标签,
比如SPAN、EM、STRONG、OPTGROUP、LABEL等,需要自定义HTML标签属性时，首先考虑是否存在已有的合适标签可替换，如果没有,
可使用须以“data-”为前缀来添加自定义属性，避免使用其他命名方式。
语义化HTML。
尽可能减少
嵌套。
书写链接地址时避免重定向。
HTML中对于属性的定义，确保全部使用双引号，绝不要使用单引号

css书写规范：

为了欺骗W3C的验证工具,可将代码分为两个文件，一个是针对所有浏览器,一个只针对IE。即将所有符合W3C的代码写到一个文件中,而一些IE中必须而又不能通过W3C验证的代码（如:
cursor:hand;）放到另一个文件中，再用下面的方法导入。
CSS样式新建或修改尽量遵循以下原则。
CSS属性显示顺序。
CSS书写顺序。
兼容多个浏览器时，将标准属性写在底部。
使用选择器时，命名比较短的词汇或者缩写的不允许直接定义样式。
可用上级节点进行限定。
多选择器规则之间换行，即当样式针对多个选择器时每个选择器占一行。
优化CSS选择器。
浏览器将检查整个文档中的所有链接和每个链接的父元素，并遍历文档树去查找ID为header的祖先元素，如果找不到header将追溯到文档的根节点，解决方法如下。
使用z-index属性尽量z-index的值不要超过150（通用组的除外），页面中的元素内容的z-index不能超过10（提示框等模块除外但维持在150以下），不允许直接使用（999~9999）之间大值。
尽量避免使用CSS Hack。
避免使用低效的选择器。
六个不要三个避免一个使用。
减少使用影响性能的属性。
减少在CSS中使用滤镜表达式和图片repeat,
尤其在body当中,渲染性能极差, 如果需要用repeat的话,
图片的宽或高不能少于8px。

javaScript书写规范：

命名规范。
代码格式。
'{}'格式如下。
避免额外的逗号。
for-in循环体中必须用hasOwnProperty方法检查成员是否为自身成员，避免来自原型链上的污染。
长语句可考虑断行。
为了避免和JSLint的检验机制冲突，“.”或“+”这类操作符放在行尾。
如果模块代码中，使用其它全局变量想跳过JSLint的检查，可以在该文件中加入/*global*/声明。
使用严格的条件判断符。用===代替==，用!==代替!=，避免掉入==造成的陷阱
在条件判断时，这样的一些值表示false。
在==时，则会有一些让人难以理解的陷阱。
对于不同类型的 == 判断，有这样一些规则，顺序自上而下：
而这些取决于另外一个对比量，即值的类型，所以对于0、空字符串的判断，建议使用===
。===会先判断两边的值类型，类型不匹配时为false。
下面类型的对象不建议用new构造。
引用对象成员用obj.prop代替obj['prop']，除非属性名是变量。
从number到string的转换。
从string到number的转换，使用parseInt，必须显式指定第二个参数的进制。
从float到integer的转换。
字符串拼接应使用数组保存字符串片段，使用时调用join方法。避免使用+或+=的方式拼接较长的字符串，每个字符串都会使用一个小的内存片段，过多的内存片段会影响性能。
尽量避免使用存在兼容性及消耗资源的方法或属性。
注重HTML分离, 减小reflow, 注重性能。

图片规范：

命名应用小写英文、数字、_组合，便于团队其他成员理解。
页面元素类图片均放入img文件夹,
测试用图片放于img/testimg文件夹，psd源图放入img/psdimg文件夹。
图片格式仅限于gif、png、jpg等。
用png图片做图片时,
要求图片格式为png-8格式,若png-8实在影响图片质量或其中有半透明效果,
请为ie-6单独定义背景，并尽量避免使用半透明的png图片。
背景图片请尽可能使用sprite技术, 减小http请求。