标签:冲突 ber bsp script web应用 架构 ack 函数名 可读性
什么是可维护的代码?一般来说,可维护代码具有以下特征:
可理解性 —— 其他人可以接受代码并理解它的意图和一般途径。
直观性 —— 代码中的东西一看就能明白
可适应性 —— 代码以一种数据上的变化不要求完全重写的方法撰写
可扩展性 —— 在代码架构上已考虑到在未来允许对核心功能进行扩展
可调式性 —— 当有地方出错是,代码可以给予你足够的信息来尽可能直接地确定问题所在
那么怎样让代码变得可维护,较简单的方式就是形成一套代码的书写约定,具体如下。
1、可读性
a、缩进格式,统一的缩进格式可以很好的帮助人们来阅读代码
b、注释,每一个函数和方法都应该有注释,同时在使用了复杂的算法,或者大段代码,Hack等都需要注释,阐述其行为。
2、变量和函数命名
不要简单的使用a、b、c等毫无意义的命名,变量名最好是名词,如car、person等,而函数名应以动词开头,如setData(),返回布尔类性质的函数一般以is开头,如isReady()
3、变量类型透明
js的变量是松散类型的,当你创建大量的变量的时候,很容易会忘记这个变量所应包含的数据类型,这里介绍3种方法来帮助我们。
初始化:即在定义变量的时候同时设置一个初始值。
匈牙利标记法:即在变量名前添加一个字符来表示其数据类型,比如boolear类型就在变量名前添加一个b,即bReady
使用类型注释:
var count /*:Number*/ = 10
要注意这会和多行注释起冲突。
除了代码约定,同时还要注意松散耦合。
什么是耦合,只要应用的某个部分过分依赖于另一部分,代码就是耦合过紧。难于维护。因为Web应用所涉及的技术,有多种情况会使它变得耦合过紧,我们需要多注意这些情况,尽可能维护弱耦合的代码。
a、HTML / Js
b、Css / Js 尽可能的弱耦合,可以通过动态更改样式类(即类名)而非特定样式来实现
c、应用逻辑 / 事件处理程序
还有一些企业相关的注意事项,后续更新。
标签:冲突 ber bsp script web应用 架构 ack 函数名 可读性
原文地址:http://www.cnblogs.com/wusan/p/7674743.html