web前端开发规范

GALA
265 阅读20分钟

前端规范

项目命名

全部采用小写方式， 以下划线分隔。 例：my_project_name

目录命名

参照项目命名规则； 有复数结构时，要采用复数命名法。 例：scripts, styles, images, data_models

JS文件命名

参照项目命名规则。 例：account_model.js

CSS, SCSS文件命名

参照项目命名规则。 例：retina_sprites.scss

HTML文件命名

参照项目命名规则。 例：error_report.html

HTML

语法

  • 缩进使用2个空格；
  • 嵌套的节点应该缩进；
  • 在属性上，使用双引号，不要使用单引号；
  • 属性名全小写，用中划线做分隔符；
  • 不要在自动闭合标签结尾处使用斜线（HTML5 规范 指出他们是可选的）；
  • 不要忽略可选的关闭标签，例：</li> 和 </body>。
<!DOCTYPE html>
<html>
  <head>
    <title>Page title</title>
  </head>
  <body>
    <img src="images/company_logo.png" alt="Company">
    <h1 class="hello-world">Hello, world!</h1>
  </body>
</html>

HTML5 doctype

在页面开头使用这个简单地doctype来启用标准模式，使其在每个浏览器中尽可能一致的展现；

虽然doctype不区分大小写，但是按照惯例，doctype大写.

<!DOCTYPE html>
<html>
	...
</html>

lang属性

根据HTML5规范：

应在html标签上加上lang属性。这会给语音工具和翻译工具帮助，告诉它们应当怎么去发音和翻译。

更多关于 lang 属性的说明在这里；

在sitepoint上可以查到语言列表；

但sitepoint只是给出了语言的大类，例如中文只给出了zh，但是没有区分香港，台湾，大陆。而微软给出了一份更加详细的语言列表，其中细分了zh-CN, zh-HK, zh-TW。

<!DOCTYPE html>
<html lang="zh-CN">
  ...
</html>

字符编码

通过声明一个明确的字符编码，让浏览器轻松、快速的确定适合网页内容的渲染方式，通常指定为'UTF-8'。

<!DOCTYPE html>
<html lang="zh-CN">
  <head>
    <meta charset="UTF-8">
  </head>
  ...
</html>

IE兼容模式

用 <meta> 标签可以指定页面应该用什么版本的IE来渲染；

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge">
  </head>
  ...
</html>

引入CSS, JS

根据HTML5规范, 通常在引入CSS和JS时不需要指明 type，因为 text/css 和 text/javascript 分别是他们的默认值。

<!-- External CSS -->
<link rel="stylesheet" href="code_guide.css">

<!-- In-document CSS -->
<style>
    ...
</style>

<!-- External JS -->
<script src="code_guide.js"></script>

<!-- In-document JS -->
<script>
    ...
</script>

属性顺序

属性应该按照特定的顺序出现以保证易读性； class是为高可复用组件设计的，所以应处在第一位； id更加具体且应该尽量少使用，所以将它放在第二位。

<a class="..." id="..." data-modal="toggle" href="#">Example link</a>

boolean属性

boolean属性指不需要声明取值的属性，XHTML需要每个属性声明取值，但是HTML5并不需要； 更多内容可以参考 WhatWG section on boolean attributes：

boolean属性的存在表示取值为true，不存在则表示取值为false。
<input type="text" disabled>

<input type="checkbox" value="1" checked>

<select>
  <option value="1" selected>1</option>
</select>

减少标签数量

在编写HTML代码时，需要尽量避免多余的父节点； 很多时候，需要通过迭代和重构来使HTML变得更少。

<!-- Bad -->
<span class="avatar">
  <img src="...">
</span>

<!-- Good -->
<img class="avatar" src="...">

实用高于完美

尽量遵循HTML标准和语义，但是不应该以浪费实用性作为代价； 任何时候都要用尽量小的复杂度和尽量少的标签来解决问题。 ps: 在写html时结构与表现分离，尽量不要以表现内容来命名

HTML5标准模版

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">
  <title>HTML5标准模版</title>
</head>
<body>
	
</body>
</html>

PC端

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <meta name="keywords" content="your keywords">
  <meta name="description" content="your description">
  <meta name="author" content="author,email address">
  <meta name="robots" content="index,follow">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
  <meta name="renderer" content="ie-stand">
  <!-- Https协议默认关闭a标签与解析，使用上面可以强制打开a 标签的预解析 -->
  <meta http-equiv=“x-dns-prefetch-control” content=“on”>
  <!-- 预解析DNS -->
  <link rel=“dns-prefetch” href=“host_name_to_prefetch.com”> 

  <title>PC端HTML模版</title>

  <!-- DNS预解析 --> 
  <link rel="dns-prefetch" href="">
  <!-- DNS预解析 --> 
</head>
<body>
  ···
</body>
</html>

移动端

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, shrink-to-fit=no" >
  <meta name="format-detection" content="telephone=no" >
  <!-- Https协议默认关闭a标签与解析，使用上面可以强制打开a 标签的预解析 -->
  <meta http-equiv=“x-dns-prefetch-control” content=“on”>
  <!-- 预解析DNS -->
  <link rel=“dns-prefetch” href=“host_name_to_prefetch.com”> 

  <title>移动端HTML模版</title>
    
  <!-- DNS预解析 -->
  <link rel="dns-prefetch" href="">
  <!-- DNS预解析 --> 
</head>
<body>
  ···
</body>
</html>

CSS, SCSS

缩进

使用2个空格

.element {
  position: absolute;
  top: 10px;
  left: 10px;

  border-radius: 10px;
  width: 50px;
  height: 50px;
}

分号

每个属性声明末尾都要加分号。

.element {
  width: 20px;
  height: 20px;

  background-color: red;
}

空格

以下几种情况不需要空格：

  • 属性名后
  • 多个规则的分隔符','前
  • !important '!'后
  • 属性值中'('后和')'前
  • 行末不要有多余的空格

以下几种情况需要空格：

  • 属性值前
  • 选择器'>', '+', '~'前后
  • '{'前
  • !important '!'前
  • @else 前后
  • 属性值中的','后
  • 注释'/'后和'/'前
/* bad */
.element {
  color :red! important;
  background-color: rgba(0,0,0,.5);
}

/* good */
.element {
  color: red !important;
  background-color: rgba(0, 0, 0, .5);
}

/* bad */
.element ,
.dialog{
  ...
}

/* good */
.element,
.dialog {

}

/* bad */
.element>.dialog{
  ...
}

/* good */
.element > .dialog{
  ...
}

/* bad */
.element{
  ...
}

/* good */
.element {
  ...
}

/* bad */
@if{
  ...
}@else{
  ...
}

/* good */
@if {
  ...
} @else {
  ...
}

空行

以下几种情况需要空行：

  • 文件最后保留一个空行
  • '}'后最好跟一个空行，包括scss中嵌套的规则
  • 属性之间需要适当的空行，具体见属性声明顺序
/* bad */
.element {
  ...
}
.dialog {
  color: red;
  &:after {
    ...
  }
}

/* good */
.element {
  ...
}

.dialog {
  color: red;

  &:after {
     ...
  }
}

换行

以下几种情况不需要换行：

  • '{'前

以下几种情况需要换行：

  • '{'后和'}'前
  • 每个属性独占一行
  • 多个规则的分隔符','后
/* bad */
.element
{color: red; background-color: black;}

/* good */
.element {
  color: red;
  background-color: black;
}

/* bad */
.element, .dialog {
  ...
}

/* good */
.element,
.dialog {
  ...
}

注释

注释统一用'/* */'（scss中也不要用'//'），具体参照右边的写法；

缩进与下一行代码保持一致；

可位于一个代码行的末尾，与代码间隔一个空格。

/* Modal header */
.modal-header {
  ...
}

/*
 * Modal header
 */
.modal-header {
  ...
}

.modal-header {
  /* 50px */
  width: 50px;

  color: red; /* color red */
}

引号

最外层统一使用双引号； url的内容要用引号； 属性选择器中的属性值需要引号。

.element:after {
  content: "";
  background-image: url("logo.png");
}

li[data-type="single"] {
  ...
}

命名

类名使用小写字母，以中划线分隔 id采用驼峰式命名 scss中的变量、函数、混合、placeholder采用驼峰式命名

/* class */
.element-content {
  ...
}

/* id */
#myDialog {
  ...
}

/* 变量 */
$colorBlack: #000;

/* 函数 */
@function pxToRem($px) {
  ...
}

/* 混合 */
@mixin centerBlock {
  ...
}

/* placeholder */
%myDialog {
  ...
}

命名原则

基于姓氏命名法（继承 + 外来）

<!-- 推荐 -->
<div class="modulename">
  <div class="modulename_info">
    <div class="modulename_son"></div>
    <div class="modulename_son"></div>
    ...
  </div>
</div>
	
<!-- 这个是全站公用模块，祖先模块允许直接出现下划线 -->
<div class="mod_info">
  <div class="mod_info_son"></div>
  <div class="mod_info_son"></div>
  ...		
</div>

<!-- 不推荐 -->
<div class="modulename_info">
  <div class="modulename_info_son"></div>
  <div class="modulename_info_son"></div>
  ...		
</div>

<!-- 当子孙模块超过4级或以上的时候，可以考虑在祖先模块内具有识辨性的独立缩写作为新的子孙模块 -->
<div class="modulename">
  <div class="modulename_cover"></div>
  <div class="modulename_info">
    <div class="modulename_info_user">
      <div class="modulename_info_user_img">
      <img src="" alt="">
        <!-- 这个时候 miui 为 modulename_info_user_img 首字母缩写-->
        <div class="miui_tit"></div>
        <div class="miui_txt"></div>
        ...
      </div>
    </div>
    <div class="modulename_info_list"></div>
  </div>
</div>



模块命名：

全站公共模块：以 mod_ 开头:

<div class="mod_yours"></div>

业务公共模块：以 业务名_mod_ 开头:

<div class="beibao_mod_yours"></div>
常用模块名：
ClassName 含义
about 关于
account 账户
arrow 箭头图标
article 文章
aside 边栏
audio 音频
account 账户
avatar 头像
bg,background 背景
bar 栏（工具类）
branding 品牌化
crumb,breadcrumbs 面包屑
btn,button 按钮
caption 标题，说明
category 分类
chart 图表
clearfix 清除浮动
close 关闭
col,column 列
comment 评论
community 社区
container 容器
content 内容
copyright 版权
current 当前态，选中态
default 默认
description 描述
details 细节
disabled 不可用
entry 文章，博文
error 错误
even 偶数，常用于多行列表或表格中
fail 失败（提示）
feature 专题
fewer 收起
field 用于表单的输入区域
figure 图
filter 筛选
first 第一个，常用于列表中
footer 页脚
forum 论坛
gallery 画廊
group 模块，清除浮动
header 页头
help 帮助
hide 隐藏
hightlight 高亮
home 主页
icon 图标
info,information 信息
last 最后一个，常用于列表中
links 链接
login 登录
logout 退出
logo 标志
main 主体
menu 菜单
meta 作者、更新时间等信息栏，一般位于标题之下
module 模块
more 更多（展开）
msg,message 消息
nav,navigation 导航
next 下一页
nub 小块
odd 奇数，常用于多行列表或表格中
off 鼠标离开
on 鼠标移过
output 输出
pagination 分页
pop,popup 弹窗
preview 预览
previous 上一页
primary 主要
progress 进度条
promotion 促销
rcommd,recommendations 推荐
reg,register 注册
save 保存
search 搜索
secondary 次要
section 区块
selected 已选
share 分享
show 显示
sidebar 边栏，侧栏
slide 幻灯片，图片切换
sort 排序
sub 次级的，子级的
submit 提交
subscribe 订阅
subtitle 副标题
success 成功（提示）
summary 摘要
tab 标签页
table 表格
txt,text 文本
thumbnail 缩略图
time 时间
tips 提示
title 标题
video 视频
wrap 容器，包，一般用于最外层
wrapper 容器，包，一般用于最外层

颜色

颜色16进制用小写字母； 颜色16进制尽量用简写。

/* bad */
.element {
  color: #ABCDEF;
  background-color: #001122;
}

/* good */
.element {
  color: #abcdef;
  background-color: #012;
}

属性简写

属性简写需要你非常清楚属性值的正确顺序，而且在大多数情况下并不需要设置属性简写中包含的所有值，所以建议尽量分开声明会更加清晰；

margin 和 padding 相反，需要使用简写；

常见的属性简写包括：

  • font
  • background
  • transition
  • animation
/* bad */
.element {
  transition: opacity 1s linear 2s;
}

/* good */
.element {
  transition-delay: 2s;
  transition-timing-function: linear;
  transition-duration: 1s;
  transition-property: opacity;
}

媒体查询

尽量将媒体查询的规则靠近与他们相关的规则，不要将他们一起放到一个独立的样式文件中，或者丢在文档的最底部，这样做只会让大家以后更容易忘记他们。

.element {
  ...
}

.element-avatar{
  ...
}

@media (min-width: 480px) {
  .element {
    ...
  }

  .element-avatar {
    ...
  }
}

SCSS相关

提交的代码中不要有 @debug；

声明顺序：

  • @extend
  • 不包含 @content 的 @include
  • 包含 @content 的 @include
  • 自身属性
  • 嵌套规则 @import 引入的文件不需要开头的'_'和结尾的'.scss'；

嵌套最多不能超过5层；

@extend 中使用placeholder选择器；

去掉不必要的父级引用符号'&'。

/* bad */
@import "_dialog.scss";

/* good */
@import "dialog";

/* bad */
.fatal {
  @extend .error;
}

/* good */
.fatal {
  @extend %error;
}

/* bad */
.element {
  & > .dialog {
    ...
  }
}

/* good */
.element {
  > .dialog {
    ...
  }
}

杂项

不允许有空的规则； 元素选择器用小写字母； 去掉小数点前面的0； 去掉数字中不必要的小数点和末尾的0； 属性值'0'后面不要加单位； 同个属性不同前缀的写法需要在垂直方向保持对齐，具体参照右边的写法； 无前缀的标准属性应该写在有前缀的属性后面； 不要在同个规则里出现重复的属性，如果重复的属性是连续的则没关系； 不要在一个文件里出现两个相同的规则； 用 border: 0; 代替 border: none;； 选择器不要超过4层（在scss中如果超过4层应该考虑用嵌套的方式来写）； 发布的代码中不要有 @import； 尽量少用'*'选择器。

/* bad */
.element {
}

/* bad */
LI {
  ...
}

/* good */
li {
  ...
}

/* bad */
.element {
  color: rgba(0, 0, 0, 0.5);
}

/* good */
.element {
  color: rgba(0, 0, 0, .5);
}

/* bad */
.element {
  width: 50.0px;
}

/* good */
.element {
  width: 50px;
}

/* bad */
.element {
  width: 0px;
}

/* good */
.element {
  width: 0;
}

/* bad */
.element {
  border-radius: 3px;
  -webkit-border-radius: 3px;
  -moz-border-radius: 3px;

  background: linear-gradient(to bottom, #fff 0, #eee 100%);
  background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
  background: -moz-linear-gradient(top, #fff 0, #eee 100%);
}

/* good */
.element {
  -webkit-border-radius: 3px;
  -moz-border-radius: 3px;
  border-radius: 3px;

  background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
  background:    -moz-linear-gradient(top, #fff 0, #eee 100%);
  background:         linear-gradient(to bottom, #fff 0, #eee 100%);
}

/* bad */
.element {
  color: rgb(0, 0, 0);
  width: 50px;
  color: rgba(0, 0, 0, .5);
}

/* good */
.element {
  color: rgb(0, 0, 0);
  color: rgba(0, 0, 0, .5);
}

JavaScript

缩进

使用2个空格

var x = 1,
    y = 1;

if (x < y) {
  x += 10;
} else {
  x += 1;
}

单行长度

不要超过80，但如果编辑器开启word wrap可以不考虑单行长度。

分号

以下几种情况后需加分号：

  • 变量声明
  • 表达式
  • return
  • throw
  • break
  • continue
  • do-while
/* var declaration */
var x = 1;

/* expression statement */
x++;

/* do-while */
do {
    x++;
} while (x < 10);

空格

以下几种情况不需要空格：

  • 对象的属性名后
  • 前缀一元运算符后
  • 后缀一元运算符前
  • 函数调用括号前
  • 无论是函数声明还是函数表达式，'('前不要空格
  • 数组的'['后和']'前
  • 对象的'{'后和'}'前
  • 运算符'('后和')'前

以下几种情况需要空格：

  • 二元运算符前后
  • 三元运算符'?:'前后
  • 代码块'{'前
  • 下列关键字前：else, while, catch, finally
  • 下列关键字后：if, else, for, while, do, switch, case, try, catch, finally, with, return, typeof
  • 单行注释'//'后（若单行注释和代码同行，则'//'前也需要），多行注释'*'后
  • 对象的属性值前
  • for循环，分号后留有一个空格，前置条件如果有多个，逗号后留一个空格
  • 无论是函数声明还是函数表达式，'{'前一定要有空格
  • 函数的参数之间
// bad
var a = {
  b :1
};

// good
var a = {
  b: 1
};

// bad
++ x;
y ++;
z = x?1:2;

// good
++x;
y++;
z = x ? 1 : 2;

// bad
var a = [ 1, 2 ];

// good
var a = [1, 2];

// bad
var a = ( 1+2 )*3;

// good
var a = (1 + 2) * 3;

// 如果（ 之后有 { 那么它们之间保留空格 
var doSomething = function(a, b, c) {
  // do something
};

// )之后不需要空格
doSomething(item);

// bad
for(i=0;i<6;i++){
  x++;
}

// good
for (i = 0; i < 6; i++) {
  x++;
}

空行

以下几种情况需要空行：

  • 变量声明后（当变量声明在代码块的最后一行时，则无需空行）
  • 注释前（当注释在代码块的第一行时，则无需空行）
  • 代码块后（在函数调用、数组、对象中则无需空行）
  • 文件最后保留一个空行
// need blank line after variable declaration
var x = 1;

// not need blank line when variable declaration is last expression in the current block
if (x >= 1) {
  var y = x + 1;
}

var a = 2;

// need blank line before line comment
a++;

function b() {
  // not need blank line when comment is first line of block
  return a;
}

// need blank line after blocks
for (var i = 0; i < 2; i++) {
  if (true) {
    return false;
  }

  continue;
}

var obj = {
  foo: function() {
    return 1;
  },

  bar: function() {
    return 2;
  }
};

// not need blank line when in argument list, array, object
func(
  2,
  function() {
    a++;
  },
  3
);

var foo = [
  2,
  function() {
    a++;
  },
  3
];


var foo = {
  a: 2,
  b: function() {
    a++;
  },
  c: 3
};

换行

换行的地方，行末必须有','或者运算符；

以下几种情况不需要换行：

  • 下列关键字后：else, catch, finally
  • 代码块'{'前

以下几种情况需要换行：

  • 代码块'{'后和'}'前
  • 变量赋值后
// bad
var a = {
  b: 1
  , c: 2
};

x = y
  ? 1 : 2;

// good
var a = {
  b: 1,
  c: 2
};

x = y ? 1 : 2;
x = y ?
  1 : 2;

// no need line break with 'else', 'catch', 'finally'
if (condition) {
  ...
} else {
  ...
}

try {
  ...
} catch (e) {
  ...
} finally {
  ...
}

// bad
function test()
{
  ...
}

// good
function test() {
  ...
}

// bad
var a, foo = 7, b,
  c, bar = 8;

// good
var a,
  foo = 7,
  b, c, bar = 8;

单行注释

双斜线后，必须跟一个空格； 缩进与下一行代码保持一致； 可位于一个代码行的末尾，与代码间隔一个空格。

if (condition) {
  // if you made it here, then all security checks passed
  allowed();
}

var zhangsan = 'zhangsan'; // one space after code

多行注释

最少三行, '*'后跟一个空格，具体参照右边的写法； 建议在以下情况下使用：

  • 难于理解的代码段
  • 可能存在错误的代码段
  • 浏览器特殊的HACK代码
  • 业务逻辑强相关的代码
/*
 * one space after '*'
 */
var x = 1;

文档注释

各类标签@param, @method等请参考usejsdoc和JSDoc Guide； 建议在以下情况下使用：

  • 所有常量
  • 所有函数
  • 所有类
/**
 * @func
 * @desc 一个带参数的函数
 * @param {string} a - 参数a
 * @param {number} b=1 - 参数b默认值为1
 * @param {string} c=1 - 参数c有两种支持的取值</br>1—表示x</br>2—表示xx
 * @param {object} d - 参数d为一个对象
 * @param {string} d.e - 参数d的e属性
 * @param {string} d.f - 参数d的f属性
 * @param {object[]} g - 参数g为一个对象数组
 * @param {string} g.h - 参数g数组中一项的h属性
 * @param {string} g.i - 参数g数组中一项的i属性
 * @param {string} [j] - 参数j是一个可选参数
 */
function foo(a, b, c, d, g, j) {
  ...
}
注释名 语法 含义 示例
@param @param参数名 {参数类型} 描述信息 描述参数的信息 @param name {String} 传入名称
@return @return{返回类型} 描述信息 描述返回值的信息 @return {Boolean} true:可执行;false:不可执行
@author @author 作者信息 [附属信息：如邮箱、日期] 描述此函数作者的信息 @author 张三 2018/07/10
@version @version XX.XX.XX 描述此函数的版本号 @version1.0.3
@example @example 示例代码 @example setTitle('测试') 如下 
/**
 - 合并Grid的行
 - [@param](/user/param) grid {Ext.Grid.Panel} 需要合并的Grid
 - [@param](/user/param) cols {Array} 需要合并列的Index(序号)数组；从0开始计数，序号也包含。
 - [@param](/user/param) isAllSome {Boolean} ：是否2个tr的cols必须完成一样才能进行合并。true：完全一样；false(默认)：不完全一样
 - [@return](/user/return) void
 - [@author](/user/author) polk6 2015/07/21
 - [@example](/user/example)
 - _________________                             _________________
 - |  年龄 |  姓名 |                             |  年龄 |  姓名 |
 - -----------------      mergeCells(grid,[0])   -----------------
 - |  18   |  张三 |              =>             |       |  张三 |
 - -----------------                             -  18   ---------
 - |  18   |  王五 |                             |       |  王五 |
 - -----------------                             -----------------
*/
function mergeCells(grid, cols, isAllSome) {
    // Do Something
}

引号

最外层统一使用单引号。

// bad
var x = "test";

// good
var y = 'foo',
  z = '<div id="test"></div>';

变量命名

  • 标准变量采用驼峰式命名（除了对象的属性外，主要是考虑到cgi返回的数据）
  • 'ID'在变量名中全大写
  • 'URL'在变量名中全大写
  • 'Android'在变量名中大写第一个字母
  • 'iOS'在变量名中小写第一个，大写后两个字母
  • 常量全大写，用下划线连接
  • 构造函数，大写第一个字母
  • jquery对象必须以'$'开头命名
var thisIsMyName;

var goodID;

var reportURL;

var AndroidVersion;

var iOSVersion;

var MAX_COUNT = 10;

function Person(name) {
    this.name = name;
}

// bad
var body = $('body');

// good
var $body = $('body');

变量声明

一个函数作用域中所有的变量声明尽量提到函数首部，用一个var声明，不允许出现两个连续的var声明。

function doSomethingWithItems(items) {
  // use one var
  var value = 10,
    result = value + 10,
    i,
    len;

  for (i = 0, len = items.length; i < len; i++) {
    result += 10;
  }
}

函数

无论是函数声明还是函数表达式，'('前不要空格，但'{'前一定要有空格； 函数调用括号前不需要空格； 立即执行函数外必须包一层括号； 不要给inline function命名； 参数之间用', '分隔，注意逗号后有一个空格。

// no space before '(', but one space before'{'
var doSomething = function(item) {
  // do something
};

function doSomething(item) {
  // do something
}

// bad
doSomething (item);

// good
doSomething(item);

// requires parentheses around immediately invoked function expressions
(function() {
  return 1;
})();

// bad
[1, 2].forEach(function x() {
  ...
});

// good
[1, 2].forEach(function() {
  ...
});

// bad
var a = [1, 2, function a() {
  ...
}];

// good
var a = [1, 2, function() {
  ...
}];

// use ', ' between function parameters
var doSomething = function(a, b, c) {
  // do something
};

函数命名

动词 含义 返回值
can 判断是否可执行某个动作 ( 权限 ) 函数返回一个布尔值 true：可执行；false：不可执行
has 判断是否含有某个值 函数返回一个布尔值 true：含有此值；false：不含有此值
is 判断是否为某个值 函数返回一个布尔值 true：为某个值；false：不为某个值
get 获取某个值 函数返回一个非布尔值
set 设置某个值 无返回值、返回是否设置成功或者返回链式对象 
//是否可阅读
function canRead() {
  return true;
}
//获取姓名
function getName {
  return this.name;
}

数组、对象

对象属性名不需要加引号； 对象以缩进的形式书写，不要写在一行； 数组、对象最后不要有逗号。

// bad
var a = {
  'b': 1
};

var a = {b: 1};

var a = {
  b: 1,
  c: 2,
};

// good
var a = {
  b: 1,
  c: 2
};

括号

下列关键字后必须有大括号（即使代码块的内容只有一行）：if, else, for, while, do, switch, try, catch, finally, with。

// bad
if (condition)
  doSomething();

// good
if (condition) {
  doSomething();
}

null

适用场景：

  • 初始化一个将来可能被赋值为对象的变量
  • 与已经初始化的变量做比较
  • 作为一个参数为对象的函数的调用传参
  • 作为一个返回对象的函数的返回值

不适用场景：

  • 不要用null来判断函数调用时有无传参
  • 不要与未初始化的变量做比较
// bad
function test(a, b) {
  if (b === null) {
    // not mean b is not supply
    ...
  }
}

var a;

if (a === null) {
  ...
}

// good
var a = null;

if (a === null) {
  ...
}

undefined

永远不要直接使用undefined进行变量判断； 使用typeof和字符串'undefined'对变量进行判断。

// bad
if (person === undefined) {
  ...
}

// good
if (typeof person === 'undefined') {
  ...
}

jshint

  • 用'===', '!=='代替'==', '!='；
  • for-in里一定要有hasOwnProperty的判断；
  • 不要在内置对象的原型上添加方法，如Array, Date；
  • 不要在内层作用域的代码里声明了变量，之后却访问到了外层作用域的同名变量；
  • 变量不要先使用后声明；
  • 不要在一句代码中单单使用构造函数，记得将其赋值给某个变量；
  • 不要在同个作用域下声明同名变量；
  • 不要在一些不需要的地方加括号，例：delete(a.b)；
  • 不要使用未声明的变量（全局变量需要加到.jshintrc文件的globals属性里面）；
  • 不要声明了变量却不使用；
  • 不要在应该做比较的地方做赋值；
  • debugger不要出现在提交的代码里；
  • 数组中不要存在空元素；
  • 不要在循环内部声明函数；
  • 不要像这样使用构造函数，例：new function () { ... }, new Object；
// bad
if (a == 1) {
  a++;
}

// good
if (a === 1) {
  a++;
}

// good
for (key in obj) {
  if (obj.hasOwnProperty(key)) {
    // be sure that obj[key] belongs to the object and was not inherited
    console.log(obj[key]);
  }
}

// bad
Array.prototype.count = function(value) {
  return 4;
};

// bad
var x = 1;

function test() {
  if (true) {
    var x = 0;
  }

  x += 1;
}

// bad
function test() {
  console.log(x);

  var x = 1;
}

// bad
new Person();

// good
var person = new Person();

// bad
delete(obj.attr);

// good
delete obj.attr;

// bad
if (a = 10) {
  a++;
}

// bad
var a = [1, , , 2, 3];

// bad
var nums = [];

for (var i = 0; i < 10; i++) {
  (function(i) {
    nums[i] = function(j) {
      return i + j;
    };
  }(i));
}

// bad
var singleton = new function() {
  var privateVar;

  this.publicMethod = function() {
    privateVar = 1;
  };

  this.publicMethod2 = function() {
    privateVar = 2;
  };
};

杂项

  • 不要混用tab和space；
  • 不要在一处使用多个tab或space；
  • 换行符统一用'LF'；
  • 对上下文this的引用只能使用'_this', 'that', 'self'其中一个来命名；
  • 行尾不要有空白字符；
  • switch的falling through和no default的情况一定要有注释特别说明；
  • 不允许有空的代码块。
// bad
var a   = 1;

function Person() {
  // bad
  var me = this;

  // good
  var _this = this;

  // good
  var that = this;

  // good
  var self = this;
}

// good
switch (condition) {
  case 1:
  case 2:
    ...
    break;
  case 3:
    ...
  // why fall through
  case 4
    ...
    break;
  // why no default
}

// bad with empty block
if (condition) {

}

vs code常用插件配置

Auto Rename Tag //自动修改对应标签名
ESlint // 语法检测
jshint // 语法检测
CSScomb // css格式化
Document THis // js文件函数注释
Guides // 虚线块级对齐提示
vscode-fileheader // 文件作者及修改时间

Code Guide by @AlloyTeam
Front-End Coding Guidelines
前端开发规范之命名规范、html规范、css规范、js规范

avatar
文章
阅读
粉丝