编写可维护的代码的一个重要途径是形成一套代码的书写约定。如果你的代码易于阅读,那么代码中bug也将会很少,因为一些bug可以很容被调试,并且,其他开发者参与你项目时的门槛也会比较低。这里小编总结一下javascript的一些代码约定。
缩进
通常会使用若干空格而非制表符来进行缩进,这是因为制表符在不同的文本编辑器中显示的效果不同,小编一般是习惯4个空格,你也可以使用其他数量。(有一个调查结果是使用空格的程序员比使用制表符的平均工资高,哈哈)添加注释
一般而言,如下地方需要进行注释。
函数和方法——描述母的和用于完成任务所可能使用的算法。还需说明事先的假设及参数代表什么,函数是否有返回值
大段代码——用于完成单个任务的多行代码应该在前面放一个描述任务的注释
复杂的算法——解释你是如何做的,方便自己及其他人以后阅读
Hack——解释因浏览器的差异而修正的方法变量和函数命名
适当给变量和函数起名字对于增加代码可理解性是非常重要的。命名的一般规则如下所示:
1.变量名为动词
2.函数名以动词开始,如getAge() 返回布尔类型的函数一般以is开头,如isNumber()
3.变量和函数都应该使用合乎逻辑的名字,不要担心长度。变量类型透明
由于javascript是弱类型语言,你无法第一眼就看出变量是什么类型,所以我们应该采取一定的措施让变量类型透明。
1.初始化 当定义了一个变量后,它就会被初始化一个值,来暗示它将来应该如何应用。例子如下:
缺点:无法用于函数声明中的函数参数
2.使用匈牙利标记法指定变量类型
使用单个字符表示基本类型:“o”代表对象,“s”代表字符串,“i”表示整数,“f”表示浮点数,“b”表示布尔型。例子如下:
缺点:阻碍了没有用它时代码的直观性和句子式的特质
3.使用类型注释
例子:
缺点:不能使用多行注释一次注释大块代码。
三种都有各自的优势,可根据自己的项目确定最适合自己的。JavaScript没有一个权威的编码风格指南,但是大多数公司都有各自的代码风格。比较出名的有Google、NPM、Nodejs等,大家可自行搜索。
留言与评论(共有 0 条评论) |