JS之可维护代码的特点

可维护的代码的特点

可理解性——其他人易于理解

直观性——代码容易看明白

可适应性——以数据的变化代替完全重写

可扩展性——代码架构上考虑了未来对核心功能的可扩展性

可调式性——有地方出错时,容易定位

代码约定

可读性

  函数和方法应该包含注释

  完成单个任务的大段代码前增加注释

  复杂的算法增加注释

  Hack——hack注释

变量和函数命名

  变量名应为名词(car或person)

  函数名以动词开始(getName())

  返回布尔值的函数一般以is开头(isEnable())

  变量和函数都应使用合乎逻辑的名字,不要担心长度。(后期处理和压缩)

变量类型透明

  初始化赋值来说明变量类型(var count = -1)

  使用匈牙利标记法来指定变量类型(var bFound;    //布尔型)

  使用注释说明

松散耦合

解耦HTML/JavaScript

  html是数据,javascript是行为,二者尽量分离

  应该避免在JS中创建大量的HTML

  html呈现尽量与JS保持分离

解耦CSS/JavaScript

  css负责页面的显示

解耦应用逻辑/事件处理程序

  应用逻辑和事件处理程序分离,例如两个函数完成

编程实践

尊重对象所有权

  如果你不负责创建或维护某个对象、它的对象或者它的方法,那么你就不能对它们进行修改

避免全局变量

  关系到创建一个脚本执行的一致的和可维护的环境

  最多创建一个全局变量,让其他对象和函数存在其中

  避免与null进行比较

  直接将值与 null比较是使用过度的,并且常常由于不充分的类型检查导致错误。

使用常量

  将应用逻辑与数据修改隔离开来(例如:var Constants = { baidu: www.baidu.com})

  重复值——任何在多处用到的值都应抽取为一个常量

  用户界面字符串——任何用于显示给用户的字符串,都应被抽取出来以方便国际化。

  URLs——在 Web 应用中,资源位置很容易变更,所以推荐用一个公共地方存放所有的 URL。

  任意可能会更改的值——每当你在用到字面量值的时候,你都要问一下自己这个值在未来是不是会变化。如果答案是“是”,那么这个值就应该被     提取出来作为一个常量。

  对于企业级的 JavaScript 开发而言,使用常量是非常重要的技巧,因为它能让代码更容易维护,并且在数据更改的同时保护代码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 原文: https://github.com/ecomfe/spec/blob/master/javascript...
    zock阅读 3,391评论 2 36
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,742评论 18 399
  • 今天翻日记本看到不错的一篇,更上简书来。作于2015.11.10. 在我这个年龄,有多少值得在乎的东西,有多少不应...
    逍遥灬阅读 318评论 0 3
  • 在我开个人公众号之前,准确的说做全职妈妈之前,没想过自己有一天能写文字给别人看,还能获得一些认同和鼓励。 记得高中...
    生花阅读 382评论 1 0
  • 生活,亦是一抹绿。 身于繁华,食于繁华,饮于繁华,玩于繁华。 生活,亦是一抹绿。 清其肠,养其胃,排其酸,溶其脂,...
    小蜗先生阅读 170评论 0 0