js最佳实践1---可维护性

1. 可维护性

编写可维护的代码很重要，因为大部分开发人员都话费大量实践维护他人代码。

确保自己代码的可维护性，以便其他开发人员在此基础上更好的开展工作。

1.1 什么是可维护的代码？

• 可理解性
• 直观性
• 可适应性
• 可扩展性
• 可调试性

1.2 代码约定：一种让代码变得可维护的简单途径是形成一套JavaScript代码的书写约定。

• 可读性：要让代码具有可维护性，首先他必须可读。（代码的缩进、注释）

                1. 函数和方法:每段函数都应该包含一个注释（目的、使用算法、陈述事先假设、参数代表、是否有返回值）

                 2. 大段代码：用于完成某个任务的多行代码应该在前面放一个描述任务的注释

                 3. 复杂的算法： 如果使用了独特的算法解决了某问题，则要注释，方便自己和别人

                 4. Hack：因浏览器差异问题，js代码一般会包含一些hack.如果因为某种浏览器无法使用普通的方法，所以你需要用一些不同的方法，请放入注释中。

• 变量和函数名

             命名规则如下：

1.    变量名应为名词如car或person
2. 函数名应以动词开始，如getName().返回布尔值的函数以is开头
3. 变量名和函数都应使用合乎逻辑的名字，不要担心过长。
   

• 变量类型透明：有三种方式表明变量数据类型的方式

1. 第一种方式使初始化，当定义一个变量时，应该对其进行初始化。var found = false;
   
2. 第二种方法是使用匈牙利标记法来指定变量类型 var bFound;//布尔型
3. 第三种指定变量类型的方式是使用类型注释 ；var found/*:Booldan*/=false;