如果你看过Nicolas C.Zakas写过的任何作品,你必须承认他是个不折不扣的天才。也只有天才级的才能写出《JavaScript高级程序设计》让所有的前端攻城师人手一本。Nicolas C.Zakas除了对现代JavaScrpt技术的详细讲解,还倡导了很多最佳实践,包括渐进增强、可访问性、性能、扩展性和可维护性等。

  编写可维护的Javascript就意味着:消灭团队个体的差异达成整体的统一,以保持大家的代码风格一致和可读的、可维护性的、可扩展的。所以该系列收纳架做一个收纳整理。

  书从编码风格、编程实践以及自动化3个部分来讲。

第一部分 编程风格

  编程风格的确定会促成整个团队成员的高水准运作,因为所有的代码风格看起来极为类似就如同一个人编写。

在团队开发中,编程风格一致性变得尤为重要,原因有:

  • 任何开发者都不在乎某个文件的作者是谁,也没有必要花费额外的精力去理解代码的逻辑并且重新排版,因为所有代码的排版风格都是非常一致的,因为风格不一致会导致我们打开代码文件的第一件事情不是立即工作,而是进行缩进的排版整理。
  • 能很容易的辨别出有问题的代码并且发现错误,如果所有的代码风格很像,当看到一段与众不同的代码时,很肯能问题就出在这里。

  JSLint 和 JSHint 是两个检查编程风格的工作。不仅找出代码中潜在的错误,还能对潜在的风格问题给予提示警告。JSLint是属于“顽固派”不接受你的自定义也就是不会为你做任何改变;JSHint是属于“受教派”可以接受你的自定义个性化的检查。

第一章 基本的格式化

  编程风格的核心就是基本的格式化规范,这些规范决定着如何编写高水准的代码。

1.1 缩进层级

  缩进没有统一的共识二分成两派:

  • 使用制表符缩进。
  • 使用空格缩进。
     只要不将两者混着用,保持一致便可。个人喜欢使用制表符Tab缩进。Zakas建议4个空格,或设置 制表符Tab 替换为 4个空格为一个缩进层。
 
1.2 语句结尾
  由于JavaScript分析器会自动插入机制,所以禁止省略分号和函数中的前“{”不应该换行。
  如:

// 原始代码
function getData() {
return
{
title:"JavaScript",
...
}
} // 分析器将理解成
function getData() {
return;
{
title:"JavaScript",
...
}
} // 推荐写法
function getData() {
return {
title:"JavaScript",
...
}
}

1.3 行的长度

  行的长度不应该超过80个字符。

1.4 换行

  当一行达到了单行最大字符数或超过单屏时,应该手动换行。推荐在运算符后换行,下一行需增加两个层级的缩进(两个Tab/8个字符)]

1.5 空行

  空行推荐使用在:

  • 在每个流控制语句之前(如if/for等)。
  • 在方法之间。
  • 在方法中局部变量和第一条语句之间。
  • 在多行或单行注释之前。
  • 在方法内的逻辑片段之间插入空行,提供可读性。
  • 在一段代码的语义和另一段代码不相关之间,确保语义有关联的代码展现在一起 如:
// 不推荐写法
if(wl && wl.length){
for (i=0,l=wl.length;i<l;++i) {
...
}
} // 推荐写法
if(wl && wl.length){ for (i=0,l=wl.length;i<l;++i) {
...
}
}

1.6 命名

  JavaScripe 核心 ECMAScript,即是遵照了驼峰式大小写。

  1.6.1 变量和函数

    变量名总是应该遵循驼峰大小写命名法,并且命名的前缀应当是名词,使得可以将变量和函数区分开。 如:

// 不推荐写法: 变量看起来像函数
var getCount=10;
var isFound=true; // 推荐写法
var count=10;
var found=true;

    命名长度尽可能短并能看词知意。

    常见参考:

    can        函数返回布尔值
    has       函数返回布尔值
    is          函数返回布尔值
    get        函数返回非布尔值
    set        函数用来保存值
 
  1.6.2 常量
    在ECMAScript 6 之前,JavaSCript 不存在真正的常量的概念。然后工作中仍然把变量用作成常量的。由于我是用C#的,如果根据C#的命名规则,约定常量首字母大写来区分, 如:
// 这是我的个人约定跟本书不同(书是C语言使用大写字母和下划线命名)
var MaxCount=100;
var Url="http://www.cnblogs.com/";

  1.6.3 构造函数

    构造函数的命名是遵照 UpperCamelCase(大驼峰)命名法。

1.7 直接量

《-未完 待续-》

编写可维护的JavaScript 收纳架的更多相关文章

  1. 《编写可维护的JavaScript》之编程实践

    最近读完<编写可维护的JavaScript>,让我受益匪浅,它指明了编码过程中,需要注意的方方面面,在团队协作中特别有用,可维护性是一个非常大的话题,这本书是一个不错的起点. 本书虽短,却 ...

  2. 编写可维护的Javascript读书笔记

    写在前面:之前硬着头皮参加了java方面的编程规范培训,收货良多,工作半年有余的时候,总算感觉到一丝丝Coding之美,以及造轮子的乐趣,以至于后面开发新功能的时候,在Coding style方面花了 ...

  3. 《编写可维护的javascript》读书笔记(中)——编程实践

    上篇读书笔记系列之:<编写可维护的javascript>读书笔记(上) 上篇说的是编程风格,记录的都是最重要的点,不讲废话,写的比较简洁,而本篇将加入一些实例,因为那样比较容易说明问题. ...

  4. 《编写可维护的javascript》读书笔记(上)

    最近在读<编写可维护的javascript>这本书,为了加深记忆,简单做个笔记,同时也让没有读过的同学有一个大概的了解. 一.编程风格 程序是写给人读的,所以一个团队的编程风格要保持一致. ...

  5. 【读书笔记】读《编写可维护的JavaScript》 - 编程实践(第二部分)

    本书的第二个部分总结了有关编程实践相关的内容,每一个章节都非常不错,捡取了其中5个章节的内容.对大家组织高维护性的代码具有辅导作用. 5个章节如下—— 一.UI层的松耦合 二.避免使用全局变量 三.事 ...

  6. 编写可维护的JavaScript之编程风格

    在团队中只有每个人的编程风格一致,大家才能方便的互相看懂和维护对方的代码. 1. 层级缩进 对于层级缩进目前有两种主张:1)使用制表符这种方法有两种好处,第一,制表符和缩进层级之间是一一对应关系,符合 ...

  7. 《编写可维护的JavaScript》 笔记

    <编写可维护的JavaScript> 笔记 我的github iSAM2016 概述 本书的一开始介绍了大量的编码规范,并且给出了最佳和错误的范例,大部分在网上的编码规范看过,就不在赘述 ...

  8. 编写可维护的JavaScript代码(部分)

    平时使用的时VS来进行代码的书写,VS会自动的将代码格式化,所有写了这么久的JS代码,也没有注意到这些点.看了<编写可维护的javascript代码>之后,做了些笔记. var resul ...

  9. 推荐一本好书:编写可维护的JavaScript(可下载)

    目录 推荐一本好书:编写可维护的JavaScript(可下载) 书摘: 下载: 有些建议: 推荐一本好书:编写可维护的JavaScript(可下载) 书摘: 很多设计模式就是为了解决紧耦合的问题.如果 ...

随机推荐

  1. shiro 框架

    惊天给大家总结一点shiro框架的小知识 Apache Shiro是一个强大且易用的Java安全框架,执行身份验证.授权.密码和会话管理.使用Shiro的易于理解的API,您可以快速.轻松地获得任何应 ...

  2. Nginx安装部署以及配置文件解析

    Nginx 中的 Location 指令 是NginxHttpCoreModule中重要指令.Location 指令,是用来为匹配的 URI 进行配置,URI 即语法中的”/uri/”,可以是字符串或 ...

  3. 将*.sql数据库脚本导入到sqlserver中(sql文件导入sqlserver)

    在SqlServer中这个是用生成sql脚本生成的 要是在导入数据库用数据导入/导出向导导不进去 其实要用查询分析器来打开sql文件 然后执行就可以了

  4. hibernate中.常见的hql查询语句

    hql是非常有意识的被设计为完全面向对象的查询 基本规则: 1.hql语法类似于sql,但它后面跟的不是表名和字段名,而是类名和属性名 2.hql大小写不敏感.但是设计java类名,包名,属性名时大小 ...

  5. Numpy随机数

    Numpy随机数 np.random随机数子库 1: 基本函数 .rand(d0,d1,..dn):创建d0-dn维度的随机数数组,浮点数,范围从0-1,均匀分布 .randn(d0,d1,..dn) ...

  6. 协同过滤 spark scala

    1 http://www.cnblogs.com/charlesblc/p/6165201.html [转载]协同过滤 & Spark机器学习实战 2 基于Spark构建推荐引擎之一:基于物品 ...

  7. mark_2017_2_27

    工作总结web_acl 535 git clone “ssh://git@outergit.yonyou.com:49622/esn_web/web_acl.git" 600 git bra ...

  8. global statement

    [global statement] 在线程里,默认所有变量都是本线程局部变量,要想访问全局变量,则要先用global声明. 如全局有变量totalCount,线程中有语句 totalCount += ...

  9. SearchEngine Note

    [SearchEngine Note] 1.查全率. 2.查准率. 3.查全率与查准率的关系. 4.四大系统. 5.权威性网页反向链接多.网页的平均出席为25.7,即平均每一个网页含有25.7个指向其 ...

  10. Java工具类_随机生成任意长度的字符串【密码、验证码】

    import java.util.Random; public class PasswordCreate { /** * 获得密码 * @param len 密码长度 * @return */ pub ...