JavaScript 代码可维护性

代码可维护性

在工作中,很多时候需要在别人的代码之上构建自己的工作。让自己的代码容易维护,可以保证其他开发这更好地完成自己的工作。

什么是可维护的代码

通常来说,具备如下特点:

  • 容易理解: 无需求助原始开发者,任何人一看代码就知道它是干什么的,以及它是怎么实现的。
  • 符合常识: 代码中的一切都显得顺理成章,无论操作有多么复杂。
  • 容易适配: 即使数据发生变化也不用完全重写。
  • 容易扩展: 代码架构经过认真设计,支持未来扩展核心功能。
  • 容易调试: 出问题是,代码可以给出明确的信息,通过它能直接定位问题。

1. 编码规范

编码规范对 JavaScript 而言非常重要,因为这门语言实在太灵活了。

编码规范的一些基础知识:

可读性

  • 代码缩进
  • 代码注释
    1. 函数和方法
    2. 大型代码块
    3. 复杂的算法
    4. 使用黑科技

缩进和注释可以让代码更容易理解,将来也更容易维护。

变量和函数名

  • 变量名应该是名词,例如 car 或 person。
  • 函数名应该以动词开始,例如 getName()、handleClick()。返回布尔值的函数通常以 is 开头,比如 isEnabled()。
  • 对变量和函数都使用符合逻辑的名称。
  • 变量、函数和方法应该以小写字母开头,使用驼峰大小写(camelCase)形式,如 getName() 和 isPerson。类名应该首字母大写, 如 Data、Person。常量值应该全部大写并以下划线相接,比如 USER_NAME。
  • 名称要尽量用描述性和直观的词汇,但不要过于冗长。getName()一看就知道会返回名称,而PersonFactory 一看就知道会产生某个 Person 对象或实例。

要完全避免没有用的变量名,如不能表示所包含数据的类型的变量名。通过适当命名,代码读起来就会像故事,因此更容易理解。

变量类型透明化

  • 标明变量类型的方式可以使用初始化:
    //  通过初始化标明变量类型
    let found = false; // 布尔值
    let count = 1; // 数值
    let name = ''; // 字符串
    let person = null; // 对象

2. 编码惯例

1. 尊重对象所有权
  • 不要给实例或原型添加属性
  • 不要给实例或原型添加方法
  • 不要重定义已有的方法
2. 不声明全局变量

最多可创建一个全局变量,作为其它对象和函数的命名空间:

    // 多个全局变量:不要!
    var name = 'Jason';
    function sayName() {
        console.log(name);
    }

以上代码声明了两个全局变量: name 和 sayName()。可以像下面这样把它们包含在一个对象中。

    // 一个全局变量:推荐
    let $u = {
        name: 'Jason',
        sayName() {
            console.log(name)
        }
    }

尽量使用常量

  • 任何可能变化的值
  • 重复出现的值
  • 用户界面字符串
  • URL

使用常量是企业级JavaScript开发的重要技术,因为它可以让代码更容易维护,同时可以让代码免受数据变化的影响。

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

推荐阅读更多精彩内容