前端代码规范

一、格式化

1、缩进层级###

4个空格表示一个缩进

2、语句结尾

行的结尾推荐不省略分号,否则分析器的自动分号插入有可能会引起逻辑错误

// 原始代码
function getData() {

    return 
    {
        title: "javascript",
        author: "4399"
    }
}

// 分析器解析后
function getData() {

    return;
    {
        title: "javascript",
        author: "4399"
    };
}

// 正确写法
function getData() {

    return {
        title: "javascript",
        author: "4399"
    };
}

3、行的长度

推荐80个字符,超过则需换行。通常我们会在运算符后换行,下一行会增加两个层级的缩进。如:

callFunction(param1, param2, param3, param4, param5, param6,
        param7)

4、空行

合理地使用空行,可更好地提升代码的可读性,常见的场景有如下:

  • 在方法之间
  • 在多行或单行注释之前
  • 在方法的局部变量和第一条语句之前
  • 在方法内的逻辑片段之间插入空行,提高可读性

5、命名

使用小驼峰。例外的是,构造函数用来创建对象,为了区别,遵照大驼峰。

// 好的做法
function Person(userName) {
    this.userName = userName;
}

var myPerson = new Person("4399");

6、引号

和Java、PHP这些语言不同,使用单引号和双引号括起字符串在javascript中功能并无不同。所以你需要关心的是,你的代码应该从头到尾只保持一种风格。推荐使用单引号,因为html属性中习惯是使用双引号,在js中使用单引号,更有利于html片段的拼接。

7、null

null是一个特殊值,但我们常常误解它,将它和undefined搞混。在下列场景应当使用null。

  • 用来初始化一个变量,这个变量可能赋值为一个对象。
  • 用来和一个已经初始化的变量比较,这个变量可以是也可以不是一个对象。
  • 当函数的参数期望是对象时,用作参数传入。
  • 当函数的返回值期望是对象时,用作返回值传入。

还有下面一些场景不应当使用null。

  • 不要使用null来检测是否传入了某个参数。
  • 不要用null来检测一个未初始化的变量。

8、undefined

没有被初始化的变量都有一个初始值,即undefined。
除了类型判断之外,建议避免在代码中使用undefined。

9、空格

适当地使用空格,将可以美化你的代码,令其可读性更高。

(1)变量定义

var person = {
    userName: "4399",
    userSex: "男",
    children:[ { domain: "web4399" }, { domain: "sy4399" } ] 
}

var personArr = [ "1", "2", "3", "4" ];

(2)运算符号

var person = "4399";
var sex = "男";

if (person == "4399" && sex == "男") {

} 
else {

}

var person = (sex == "男") ? "4399" : (4399 + 1);

(3)函数定义

function addPerson(param1, param2) {
    
}

var addPerson = function(param1, param2) {

}

(5)逻辑语句

if (needAddTbody) {
    for (i = start; i < n; i++) {
        
    }
} 
else {

}

(6)注释

// 这是正确的用法

/* 这也是正确的用法 */

/*
 * 多行注释
 * 这也是正确的用法
 */

10、for循环

  • for循环用于遍历数组。

  • for-in循环用于遍历对象,一个常见的错误用法是使用for-in循环来遍历数组成员。另外推荐在for-in循环中使用hasOwnProperty(),除非你想查找原型链,这时就应当补充注释。(ps:数据显示,for循环中,for-in的效率是最慢的,因为要查找原型链,速度只有普通for循环的1/7)

    var prop;
    
    for (porp in object) {
        if (object.hasOwnPerproty(prop)) {
            // do something
        }
    }
    

11、待续

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容