笔记--js开发规范

引言

本文主要围绕命名规范，注释规范，和框架开发规范三部分开展。
命名规范主要介绍变量、函数、常量、构造函数、；类的成员等等的命名规范；注释规范主要介绍单行注释、多行注释以及函数注释。框架开发主要介绍了全局变量冲突、单全局变量以及命名空间。

一、命名规范：

驼峰式命名法介绍：
驼峰式命名法由小（大）写字母开始，后续每个单词首字母都大写。
按照第一个字母是否大写，分为：
① Pascal Case 大驼峰式命名法：首字母大写。Eg:StudentInfo,UesrInfo
② Camel Case 小驼峰式命名法：首字母小写。Eg:studentInfo,UserInfo

1.1变量

命名方法：小驼峰式命名法。
命名规范：前缀应当是名词。（函数的名字前缀为动词，以此区分变量和函数）
命名建议：疆良在变量名字中体现所属类型，如：length、count等表示数字类型；而包含name、title表示为字符串类型。
命名规则：

不要再命名中使用“$”和“\”，不要把“_”作为变量名的第一个字符。
标识符应当只管且可以拼读，最好采用英文单词或其组合，便于记忆和阅读。切记使用汉语拼音来命名。程序中的英文单词一般不会太复杂，用词应当准确。
标识符的长度在不影响标识符意义的前提下应当尽量精简。当标识符需要由多个单词组成时，应当将单个单词长度想三靠近。
程序中不要出现紧靠大小写区分的相似的标识符。
程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生于语法错误，但会使人误解。
用正确的反义词命名具有互斥意义的或相反动作的函数等。
尽量避免名字中出现数字编号如：value1,value2等，除非逻辑上的确需要编号。

变量声明：尽管 JavaScript 语言并不要求在变量使用前先对变量进行声明。但我们还是应该养成这个好习惯。这样可以比较容易的检测出那些未经声明的变量，避免其变为隐藏的全局变量，造成隐患。
在函数的开始应先用 var 关键字声明函数中要使用的局部变量，注释变量的功能及代表的含义，且应以字母顺序排序。每个变量单独占一行，以便添加注释。这是因为 JavaScript 中只有函数的 {} 表明作用域，用 var 关键字声明的局部变量只在函数内有效，而未经 var 声明的变量则被视为全局变量。示例：

<script language="javascript">var valueA = "a";var valueB = "b";function f1() {var valueA = "c";alert("valueA="+valueA);   // valueA=cvalueB = "d";alert("valueB="+valueb);  // valueB=d}f1();alert("valueA="+valueA);  // valueA=aalert("valueB="+valueb);  // valueB=d

用 var 声明过的变量 valueA 和没有声明的变量 valueB 是有区别的。特别需要注意的是，在函数内部用 var 声明的变量为局部变量，这样可以有效地避免因局部变量和全局变量同名而产生的错误。

1.2 函数

命名方法：小驼峰式命名法。
命名规范：前缀应当为动词。统一使用动词或者动词[+名词]形式，例如：fGetVersion()，fSubmitForm()，fInit();涉及返回逻辑值的函数可以使用is，has等表示逻辑的词语代替动词。如果有内部函数，使用__f+动词[+名词]形式，内部函数必需在函数最后定义。
对象方法命名使用 f+对象类名+动词[+名词]形式;例如 fAddressGetEmail。
某事件响应函数命名方式为触发事件对象名+事件名或者模块名+触发事件对象名+事件名，例如：fDivClick()，fAddressSubmitButtonClick()
命名建议：可使用常见动词约定。