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 开发而言,使用常量是非常重要的技巧,因为它能让代码更容易维护,并且在数据更改的同时保护代码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容

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