web前端开发规范

最新推荐文章于 2024-08-27 13:38:21 发布

xiao_shutong

最新推荐文章于 2024-08-27 13:38:21 发布

阅读量277

点赞数

分类专栏：其他文章标签： javascript web前端开发文档开发规范

本文链接：https://blog.csdn.net/xiao_shutong/article/details/78395660

版权

其他专栏收录该内容

4 篇文章 0 订阅

订阅专栏

规范目的：

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

通用规范：

文件内容编码均统一为UTF-8。
CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。

文件规范：

文件名用英文单词，多个单词用驼峰命名法。
html，css，js，images , fonts等文件目录结构如下：

├── xxx.html 
├── css/   
│     ├── xxx.css  
│     ├── xxx.min.css 
│     └── images/  
│     │     ├── xxx.jpg 
│     │     └── xxx.png 
├── js/   
│     ├── xxx.js  
│     ├── xxx.min.js 
└── images/  
│     ├── xxx.jpg 
│     └── xxx.png 
└── fonts/        
       └── xxx.ttf

html规范：

为每个HTML页面的第一行添加标准模式（standard mode）的声明，确保在每个浏览器中拥有一致的展现。

<!DOCTYPE html>

文档类型声明统一为HTML5声明类型，编码统一为UTF-8。

<meta charset="UTF-8">

HEAD 中添加信息。

<meta name="author" content="smile@kang.cool">//作者
<meta name="description" content="hello">//网页描述
<meta name="keywords" content="a,b,c">//关键字,“，”分隔
<meta http-equiv="expires" content="Wed, 26 Feb 1997 08：21：57 GMT">//设定网页的到期时间。一旦网页过期，必须到服务器上重新调阅
<meta http-equiv="Pragma" content="no-cache">//禁止浏览器从本地机的缓存中调阅页面内容
<meta http-equiv="Window-target" content="_top">//用来防止别人在框架里调用你的页面
<meta http-equiv="Refresh" content="5;URL=http://kahn1990.com/">//跳转页面，5指时间停留5秒 网页搜索机器人向导。用来告诉搜索机器人哪些页面需要索引，哪些页面不需要索引
<meta name="robots" content="none">//content的参数有all,none,index,noindex,follow,nofollow，默认是all
<link rel="Shortcut Icon" href="favicon.ico">//收藏图标
<meta http-equiv="Cache-Control" content="no-cache, must-revalidate">//网页不会被缓存

IE支持通过特定标签来确定绘制当前页面所应该采用的IE版本。除非有强烈的特殊需求，否则最好是设置为edge mode ，从而通知IE采用其所支持的最新的模式。

<meta http-equiv="X-UA-Compatible" content="IE=Edge">

非特殊情况下CSS样式文件外链至HEAD之间，JAVASCRIPT文件外链至页面底部。

<!DOCTYPE html>
<html>
<head>
    <link rel="stylesheet" href="css/main.css">
</head>
<body>
    <!-- 逻辑代码 -->
    <!-- 逻辑代码底部 -->
    <script src="lib/jquery/jquery-2.1.1.min.js"></script>
</body>
</html>

引入JAVASCRIPT库文件，文件名须包含库名称及版本号及是否为压缩版。

jQuery-1.8.3.min.js

HTML属性应当按照以下给出的顺序依次排列，来确保代码的易读性。

class
id 、 name
data-*
src、for、 type、 href
title、alt

所有标签必须闭合，属性值必须用双引号“”，避免使用中文拼音尽量简易并要求语义化。

HTML中对于属性的定义，确保全部使用双引号，绝不要使用单引号

css书写规范：

CSS样式新建或修改尽量遵循以下原则。
尽量通过继承和层叠重用已有样式。
不要轻易改动全站级CSS。改动后，要经过全面测试。
CSS属性显示顺序。
显示属性（显示隐藏）
元素位置
元素属性（宽高等）
元素内容属性（字体颜色背景等）
CSS书写顺序。

.header {
/* 显示属性 */
    display || visibility
    list-style
    position top || right || bottom || left
    z-index
    clear
    float
/* 自身属性 */
    width max-width || min-width
    height max-height || min-height
    overflow || clip
    margin
    padding
    outline
    border
    background
/* 文本属性 */
    color
    font
    text-overflow
    text-align
    text-indent
    line-height
    white-space
    vertical-align
    cursor
    content
    };

兼容多个浏览器时，将标准属性写在底部。

-moz-border-radius: 15px; /* Firefox */
-webkit-border-radius: 15px; /* Safari和Chrome */
border-radius: 15px; /* Opera 10.5+, 以及使用了IE-CSS3的IE浏览器 *//标准属性

使用选择器时，命名比较短的词汇或者缩写的不允许直接定义样式。

.hd,.bd,.td{};  //如这些命名

可用上级节点进行限定。

.recommend-mod  .hd

多选择器规则之间换行，即当样式针对多个选择器时每个选择器占一行。

button.btn,
input.btn,
input[type="button"] {…};

优化CSS选择器。

#header a { color: #444; };  /*CSS选择器是从右边到左边进行匹配*/

使用z-index属性尽量z-index的值不要超过150（通用组的除外），页面中的元素内容的z-index不能超过10（提示框等模块除外但维持在150以下），不允许直接使用（999~9999）之间大值。
尽量避免使用CSS Hack。

property:value; /* 所有浏览器 */
+property:value; /* IE7 */
_property:value; /* IE6 */
*property:value; /* IE6/7 */
property:value\9; /* IE6/7/8/9，即所有IE浏览器 */

六个不要三个避免一个使用。

不要在标签上直接写样式
不要在CSS中使用@import
不要在CSS中使用!important
不要在CSS中使用“*”选择符
不要将CSS样式写为单行
避免使用filter
避免使用行内（inline）样式
避免使用“*”设置{margin: 0; padding: 0;}
使用after或overflow的方式清浮动

减少使用影响性能的属性。

减少在CSS中使用滤镜表达式和图片repeat 。

javaScript书写规范：

命名规范。

常量名
    全部大写并单词间用下划线分隔
    如：CSS_BTN_CLOSE、TXT_LOADING

对象的属性或方法名
    小驼峰式（little camel-case）
    如：init、bindEvent、updatePosition
    示例：Dialog.prototype = {
                init: function () {},
                bindEvent: function () {},
                updatePosition: function () {}
                …
                };
类名（构造器）
    -->小驼峰式但首字母大写
    -->如：Current、DefaultConfig
函数名
    -->小驼峰式
    -->如：current()、defaultConfig()
变量名
    -->小驼峰式
    -->如：current、defaultConfig
私有变量名
    -->小驼峰式但需要用_开头
    -->如：_current、_defaultConfig
变量名的前缀

代码格式。

"()"前后需要跟空格
"="前后需要跟空格
","后面需要跟空格
JSON对象需格式化对象参数
if、while、for、do语句的执行体用"{}"括起来

“{}”格式如下。

if (a==1) {
    //代码
};

避免额外的逗号。

var arr = [1,2,3,];

for-in循环体中必须用hasOwnProperty方法检查成员是否为自身成员，避免来自原型链上的污染。

长语句可考虑断行。

TEMPL_SONGLIST.replace('{TABLE}', da['results'])
    .replace('{PREV_NUM}', prev)
    .replace('{NEXT_NUM}', next)
    .replace('{CURRENT_NUM}', current)
    .replace('{TOTAL_NUM}', da.page_total);

为了避免和JSLint的检验机制冲突，“.”或“+”这类操作符放在行尾。

TEMPL_SONGLIST.replace('{TABLE}', da['results']).
    replace('{PREV_NUM}', prev).
    replace('{NEXT_NUM}', next).
    replace('{CURRENT_NUM}', current).
    replace('{TOTAL_NUM}', da.page_total);

使用严格的条件判断符。用===代替==，用!==代替!=，避免掉入==造成的陷阱

在条件判断时，这样的一些值表示false。

null
undefined与null相等
字符串''
数字0
NaN

在==时，则会有一些让人难以理解的陷阱。

(function () {
    var undefined;
    undefined == null; // true
    1 == true; //true
    2 == true; // false
    0 == false; // true
    0 == ''; // true
    NaN == NaN;// false
    [] == false; // true
    [] == ![]; // true
})();

对于不同类型的 == 判断，有这样一些规则，顺序自上而下：

undefined与null相等
一个是number一个是string时，会尝试将string转换为number
尝试将boolean转换为number
0或1
尝试将Object转换成number或string

而这些取决于另外一个对比量，即值的类型，所以对于0、空字符串的判断，建议使用===。===会先判断两边的值类型，类型不匹配时为false。

如下类型的对象非特殊情况禁止用new构造。

new Number
new String
new Boolean
new Object //用{}代替
new Array //用[]代替

从number到string的转换。

从string到number的转换，使用parseInt，必须显式指定第二个参数的进制。

/** 推荐写法*/
var a = '1';
var aa = parseInt(a,10);
typeof(a); //"string"
console.log(a); //'1'
typeof(aa); //"number"
console.log(aa); //1

从float到integer的转换。

/** 推荐写法*/
Math.floor/Math.round/Math.ceil
/** 不推荐写法*/
parseInt

字符串拼接应使用数组保存字符串片段，使用时调用join方法。避免使用+或+=的方式拼接较长的字符串，每个字符串都会使用一个小的内存片段，过多的内存片段会影响性能。

/**推荐的拼接方式array的push、join*/
var str=[],
    list=['测试A','测试B'];
for (var i=0 , len=list.length; i < len; i++) {
    str.push( '<div>'+ list[i] + '</div>');
};
console.log(str.join('')); //<div>测试A</div><div>测试B</div>
/** 不推荐的拼接方式+=*/
var str = '',
    list=['测试A','测试B'];
for (var i = 0, len = list.length; i< len; i++) {
    str+='<div>' + list[i] + '</div>';
};
console.log(str); //<div>测试A</div><div>测试B</div>

尽量避免使用存在兼容性及消耗资源的方法或属性。

不要使用with，void，evil，eval_r，innerText

尽量使用 jQuery 扩展的方式定义公共方法。

// 扩展示例：
$.fn.highlight1 = function () {
    // this已绑定为当前jQuery对象:
    this.css('backgroundColor', '#fffceb').css('color', '#d85030');
    return this;
}

// 调用示例：
<!-- HTML结构 -->
<div id="test-highlight1">
    <p>什么是<span>jQuery</span></p>
    <p><span>jQuery</span>是目前最流行的<span>JavaScript</span>库。</p>
</div>

$('#test-highlight1 span').highlight1();

图片规范：

命名应用小写英文、数字、_组合，便于团队其他成员理解。

图片格式仅限于gif、png、jpg等（建议统一为png格式）。
用png图片做图片时，要求图片格式为png-8格式，若png-8实在影响图片质量或其中有半透明效果，请为ie-6单独定义背景，并尽量避免使用半透明的png图片。
背景图片请尽可能使用sprite技术,，减小http请求。

注释规范：

给区块代码及重要功能(比如循环)加上注释, 方便以后添加功能;
待办事项
!– TODO:待办事项:未改进或有为实现的功能 –
JAVASCRIPT、CSS文件注释需要标明作者、文件版本、创建/修改时间、重大版本修改记录、函数描述、文件版本、创建或者修改时间、功能、作者等信息。

/* * 注释块 */

中间可添加如下信息。

**重要项：**

@class 用来给一个类提供描述，不能用于构造器的文档中
@param 用大括号中的参数类型描述一个参数
@requires 表示需要另一个函数/类
@return 描述一个函数的返回值
@throws 描述函数/类可能产生的错误
@example 方法/函数调用示例
@author 函数/类作者的姓名

**可选项：**
@file 文件名
@addon 把一个函数标记为另一个函数的扩张，另一个函数的定义不在源文件中
@argument 用大括号中的自变量类型描述一个自变量
@base 如果类是继承得来，定义提供的类名称
@constructor 描述一个类的构造器
@deprecated 表示函数/类已被忽略
@exception 描述函数/类产生的一个错误
@exec @extends 表示派生出当前类的另一个类
@fileoverview 表示文档块将用于描述当前文件，这个标签应该放在其它任何标签之前
@final 指出函数/类
@ignore 让jsdoc忽视随后的代码
@link 类似于@link标签，用于连接许多其它页面
@member 定义随后的函数为提供的类名称的一个成员
@private 表示函数/类为私有，不应包含在生成的文档中
@see 连接到另一个函数/类
@type 指定函数/成员的返回类型
@version 函数/类的版本号

命名：

html文件命名: 英文命名, 后缀.html. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便添加功能时查找对应页面；
css文件命名: 英文命名, 后缀.css，共用common.css，其他页面依实际模块需求命名；
Js文件命名: 英文命名, 后缀.js，共用common.js，其他依实际模块需求命名；
html 与 js 命名对应，每个页面只允许有一个 js 文件处理前后端交互逻辑；
class与id命名:

大的框架命名比如header/footer/wrapper/left/right之类的在2中由i统一命名.其他样式名称由小写英文 & 数字 & _ 来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合; 总之, 命名要语义化, 简明化.

重复使用率高的命名, 请以自己代号加下划线起始, 比如 zhangsan_clear;

开发及测试工具约定：

编码格式化，三码统一。

协作开发及分工：

i 根据各个模块及根据页面相似程序, 事先写好大体框架文件, 分配给前端人员实现内部结构&表现&行为; 共用css文件common.css由 i 书写, 协作开发过程中, 每个页面请务必都要引入, 此文件包含reset及头部底部样式, 此文件必须经过多数前端人员同意并告知所有人后方可修改 ;

其他开发问题：

session问题：触发事件时缓存，不触发不缓存；
缓存参数较多且只有个别页面使用时建议把缓存打包为JSON对象，做好缓存管理；
传参只有下一个页面需要且参数较短时，建议参数放进url中，同一个页面有不同的入口时参数必须放进url；
公共页面参数完整且一致，缓存及url 一致；
公共样式及行为必须采用common文件，全系统一致；
尽量不使用多层嵌套判断，保证代码逻辑清晰，复杂片段必须有详尽备注；

xiao_shutong

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
web前端开发规范

规范目的：为提高团队协作效率, 便于添加功能及前端后期优化维护, 输出高质量的代码, 特制订此文档。本规范一经确认, 前端开发人员必须按本规范进行开发. 本文档如有错误或不合适的地方请及时提出, 经讨论决定后方可更改。通用规范：文件内容编码均统一为UTF-8。 CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”。 CS
复制链接

扫一扫

专栏目录