读高程有感之JavaScript代码可维护性

近期一直在研读高级程序设计一书，其中第二十四章《最佳实践》中提到代码的可维护性，其中本人深有感触。

可维护性

在从事IT编程工作一段时间后发现，每进一家新公司，都要花大量的时间去研读别人的代码，其余剩下的大量时间都是维护别人的代码，由于编程人员水平的参差不齐，所有经常在看上一个同事代码的时候也很难抑制内心的冲动，这写的什么鬼，一句注释没有，重复的代码这么多也不封装，所以编写可维护性的代码尤为重要，并且我觉得一个程序员一开始就应该先养成良好的代码习惯，做到像写诗一样写代码，从而能力才能更进一步，在我认为，代码风格都不好，其他一切都是空谈。

什么是可维护的代码

可维护的代码有一些特征。一般来说，如果说代码是可维护的，它需要遵循以下特点。
1、可理解性——其他人可以接手代码并理解它的意图和一般途径，而无需原开发人员的完整解释。
2、直观性——代码中的东西一看就能明白，不管其操作过程多么复杂。
3、可适应性——代码以一种数据上的变化不要求完全重写的方法撰写。
4、可扩展性——在代码架构上已考虑到在未来允许对核心功能进行扩展。
5、可调试性——当有地方出错时，代码可以给予你足够的信息来尽可能直接地确定问题所在。
对于专业人士而言，能写出可维护的 JavaScript 代码是非常重要的技能。

代码的约定

绝大多数语言都有各自的代码约定，只要在网上一搜就能找到大量相关文档。由于 JavaScript 的可适应性，代码约定对它也很重要。这里建议大家有空经常到github上看一下别人的开源代码，会有意想不到的收获及思路。

1. 可读性

可读性与代码作为文本文件的格式化方式有关。当所有人都使用一样的缩进方式时，整个项目中的代码都会更加易于阅读。目前许多框架都提供了这么一个检测代码的插件，eslint也是一个不错的练习，如vue-cli在构建项目时也会问你是否开启eslint，个人觉得是个不错的养成代码良好风格的练习方式

2. 多写注释

很多时候我上个星期写的代码，这个星期就不记得了，所有多写注释十分重要

3. 变量名和函数名

变量名应为名词 如 car 或 person
函数名应该以动词开始，如 getName()
返回布尔类型值的函数一般以 is 开头，如 isEnable() 。
变量和函数都应使用合乎逻辑的名字，不用担心长度。因为最终在生产环境下代码可以被压缩打包，例如webpack和gulp都提供了这些功能。

4. 变量类型透明

由于在 JavaScript 中变量是松散类型的，很容易就忘记变量所应包含的数据类型。合适的命名方式
可以一定程度上缓解这个问题，但放到所有的情况下看，还不够。有三种表示变量数据类型的方式。
//第一种方式：通过初始化指定变量类型

var found = false; //布尔型
var count = -1; //数字
var name = ""; //字符串
var person = null; //对象

初始化为一个特定的数据类型可以很好的指明变量的类型。但缺点是它无法用于函数声明中的函数参数。
//第二种方法：用指定数据类型的匈牙利标记法，这个标记法在脚本语言中很流行，曾经很长时间也是 JavaScript 所推崇的方式，”o” 代表对象， “s” 代表字符串， “i”
代表整数， “f” 代表浮点数， “b” 代表布尔型

var bFound; //布尔型
var iCount; //整数
var sName; //字符串
var oPerson; //对象

JavaScript 中用匈牙利标记法的好处是函数参数一样可以使用。但它的缺点是让代码某种程度上难以阅读，阻碍了没有用它时代码的直观性和句子式的特质。因此，匈牙利标记法失去了一些开发者的宠爱。
//第三种方法：用于指定类型的类型注释 类型注释放在变量名右边，但是在初始化前面。

var found /*:Boolean*/ = false;
var count /*:int*/ = 10;
var name /*:String*/ = "Nicholas";
var person /*:Object*/ = null;

类型注释维持了代码的整体可读性，同时注入了类型信息。类型注释的缺点是你不能用多行注释一次注释大块的代码，因为类型注释也是多行注释，两者会冲突 。
这三种常见指定变量数据类型的方法。每种都有各自的优势和劣势，要自己在使用之前进
行评估。最重要的是要确定哪种最适合你的项目并一致使用。