1.命名
在开发前必须有个命名规范来对代码统一规范团队代码结构,使代码可读性提高
2.注释
我相信每个人看别人代码时看到密密麻麻的代码结构,相信每个人都会很头疼,即使想看也会看不下去,而且很耗时间,所以注释就变得尤其得重要,注释越清楚越详细我相信代码可维护性越高,而且更容易修改维护
3.变量
在js中变量无处不在,所以这么声明变量就变得尤其得重要,首先少使用全局变量,这样会增加加载速度,从而导致项目用户体验不好
4.声明变量如果不用 var 会导致变量成为全局变量。
5.函数
函数的参数数量
函数的参数不应该超过 3 个。如果函数的参数超过 3 个,应该将一些参数进行封装。
6.函数参数传递
只传函数需要的参数。如
// 不推荐
function greet(data){
console.log('Hello, I am ' + data.name)
}
// 推荐
function greet(name){
console.log('Hello, I am ' + name)
}
7.函数的功能
一个函数只做一件事。这有助于测试和代码复用。
函数尽可能无副作用。无副作用指不修改传入的参数和全局变量。
8.减少重复代码
. 记得在某个文章中看到说,如果重复的代码出现 3 次,就应该重构重复的代码。
. 松耦合
. 一个函数只做一件事
. 缓存一些计算结果
9.避免全局变量
. 从分配置和离逻辑代码
. 不要修改不属于你的对象
. 不属于你的对象包括
. 浏览器原生对象,如 Object,Array等
DOM,如 document
BOM,如 window
类库对象
如果想拓展浏览器原生对象的功能,可以创建函数,函数中把浏览器原生对象传入。如Underscore.js 做 的那样。
10.代码风格的统一
11.尽可能的避免代码重复
.如何减少重复的代码呢?
.在JS中,可以将重复的代码写成一个方法,如果是可通用的,可以写在独立的JS文件中。
.在CSS中,则需要借助Sass,Less之类的预处理语言的Mixins的功能。将重复的部分写成一个Mixins。
12.配置和逻辑分开
. JS中,对于整个站的通用配置,写在config.js里。如果是某个js的配置,在文件的开头,用defaultParam 对象来存放可变的配置,用const来定义不可变的配置
. CSS中,依旧要借助预处理语言。对于整站的配置,定 义在_variables.scss里。对于某个具体CSS文件里,在文件开头用变量来定义
13.减少代码的副作用
1>JS中,方法中的沟通尽量不要用全局变量;不要在Array之类的全局对象的原型链上添加方法;尽量不要定义全局的方法和变量:如果确实有很多变量,方法放在全局上,可以学习jQuery,将很多变量,方法放在一个全局对象上;自定义事件,事件的名称也要有命名空间。
2>CSS中,要做到无副作用,难度很大。对于简单页面,一个方法是,把页面上的元素都分成一个个组件,写样式时,选择器要用组件选择器 当前元素选择器。当组件变的复杂时,组件也会包含很多子组件。然后,选择器就会越来越长。。。我的解决方案是用的BEM。
14.提高代码的可读性
.变量,方法等的合理命名,通过名称可以知道这个大概做什么的。
.如果则要加注释来说明一下。对于不容理解的代码加注释
.尽可能不用魔法数字
.对于HTML,选择合适标签
15.一个方法只做一件事
一来提高代码的复用性,二来让调试也变的更容易,三来让测试变的更容易
编写可维护的代码
软件的BUG修复需要花费大量的精力。尤其当代码已经发布之后,随着时间的增长,维护的成本愈发的高。当你一发现BUG的时候,就立即去修复,这时候你的代码还是热乎的,你也不需要回忆,因为就是刚刚写好的。但是当你做了其他任务,几乎完全忘记了这份代码,这时候就需要:
重新学习和理解问题
理解代码是如何解决问题的
另外一个问题是,在大项目或者大公司里面,经常是解决BUG的人不是产生BUG的人,而且也不是发现BUG的人。所以减少理解代码的时间就是最重要 的问题,无论这个代码是你自己以前写的还是团队中的其他成员写的,因为我们都想去搞搞新的有意思的东西,而不是去维护那些个陈旧的代码。
还有一个开发中的普遍问题就是,往往读代码的时间比写代码的时间还要多。有时候你钻研一个问题,可以花整整一个下午的时间来考虑代码的编写。这个代码当时是可以工作的,但是随着开发的进行,其他东西发生了很大的变化,这时候也就需要你自己来重新审查修改编写代码。比如:
还有BUG没有解决
添加了新的功能
程序需要在新的环境中运行(比如一个新上市的浏览器)
代码有问题
代码需要重写因为修改了架构甚至要使用另一个语言
因为这些原因,也许你当时一个下午写好的代码,后面需要花费几周的时间来阅读。所以编写可维护的代码对于软件的成功至关重要。
可维护的代码包括:
可读性
连续性
预见性
看起来是一个人写的
有文档
最少化全局变量
河南新华