可维护性
编写可维护的代码很重要,因为大部分开发人员都花费大量时间维护他人代码。很难从头开始开发新代码的,很多情况下是以他人成果为基础的。确保自己代码的可维护性,以便其他开发人员在此基础上更好的开展工作。
什么是可维护的代码?
可理解性:其他人可以接手代码并理解它的意图和一般途径,而无需原开发人员的完整解释
直观性:代码中的东西一看就能明白,不管其操作过程多么复杂
可适应性:代码以一种数据上的变化不要求完全重写的方法撰写
可扩展性:在代码架构上已考虑到在未来允许对核心功能进行扩展
可调试性:当有地方出错时,代码可以给予你足够的信息来尽可能直接地确定问题所在
代码约定
代码约定是一种让代码变得可维护的简单途径是形成一套JavaScript代码的书写约定。
可读性:要让代码具有可维护性,首先他必须可读。可读性的大部分内容都是和代码缩进相关的,还有一方面是注释。包括以下几个方面:
函数和方法:每个函数或方法都应该包含一个注释,描述其目的和用于完成任务所可能使用的算法。陈述事先的假设也非常重要,如参数代表什么,函数是否有返回值
大段代码:用于完成某个任务的多行代码应该在前面放一个描述任务的注释
复杂的算法: 如果你使用了一种独特的方式解决某个问题,则要在注释中注释你是如何做的。这不仅仅可以帮助其他浏览你代码的人,也能在下次你自己查阅代码的时候帮助理解。
Hack:因浏览器差异问题,js代码一般会包含一些hack。如果因为某种浏览器无法使用普通的方法,所以你需要用一些不同的方法,请放入注释中。
变量和函数名
命名规则如下:
变量名应为名词如car或person
函数名应以动词开始,如getName()。返回布尔值的函数以is开头,如isEnable()
变量名和函数都应使用合乎逻辑的名字,不要担心长度。长度可以通过后处理和压缩来缓解
变量类型透明
有三种方式表明变量数据类型的方式:
初始化:当定义一个变量后,它应该被初始为一个值,来暗示它将来如何应用。
比如:var found = false;
初始化为一个特定的数据类型可以很好的指明变量的类型。但缺点是它无法用于函数声明中的参数。
使用匈牙利标记法来指定变量类型
“o”代表对象,”s”代表字符串,”i”代表整数,”f”代表浮点数,”b”代表布尔型
比如:var bFound;//布尔型
匈牙利标记法的好处是函数参数一样可以使用。但是缺点是让代码某种程度上难以阅读,阻碍了没有用它时代码的直观性和句子式的特质。
使用类型注释
var found/*:Booldan*/=false;1
类型注释的缺点是你不能使用多行注释一次性注释大块的代码,因为类型注释也是多行注释,两者会冲突。
松散耦合
只要应用的某个部分过分依赖于另一部分,代码就是耦合过紧、难于维护。典型的问题如:对象直接引用另一个对象,并且当修改其中一个的同时需要修改另外一个。紧密耦合的软件难于维护并且需要经常重写。
解耦html/javascript
html和javascript各自代表了解决方案中的不同层次:html是数据,javascript是行为。因为他们天生就需要交互,所以有多种不同的方法将这两个技术关联起来。
情况一:直接写在html中的javascript,使用包含内联代码的标签中一样可以使用el表达式
Das obige ist der detaillierte Inhalt von在JS开发中最实用的问题解答. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!