读高程有感之JavaScript代码可维护性

近期一直在研读高级程序设计一书,其中第二十四章《最佳实践》中提到代码的可维护性,其中本人深有感触。

可维护性

在从事IT编程工作一段时间后发现,每进一家新公司,都要花大量的时间去研读别人的代码,其余剩下的大量时间都是维护别人的代码,由于编程人员水平的参差不齐,所有经常在看上一个同事代码的时候也很难抑制内心的冲动,这写的什么鬼,一句注释没有,重复的代码这么多也不封装,所以编写可维护性的代码尤为重要,并且我觉得一个程序员一开始就应该先养成良好的代码习惯,做到像写诗一样写代码,从而能力才能更进一步,在我认为,代码风格都不好,其他一切都是空谈。

什么是可维护的代码

可维护的代码有一些特征。一般来说,如果说代码是可维护的,它需要遵循以下特点。
1、可理解性——其他人可以接手代码并理解它的意图和一般途径,而无需原开发人员的完整解释。
2、直观性——代码中的东西一看就能明白,不管其操作过程多么复杂。
3、可适应性——代码以一种数据上的变化不要求完全重写的方法撰写。
4、可扩展性——在代码架构上已考虑到在未来允许对核心功能进行扩展。
5、可调试性——当有地方出错时,代码可以给予你足够的信息来尽可能直接地确定问题所在。
对于专业人士而言,能写出可维护的 JavaScript 代码是非常重要的技能。

代码的约定

绝大多数语言都有各自的代码约定,只要在网上一搜就能找到大量相关文档。由于 JavaScript 的可适应性,代码约定对它也很重要。这里建议大家有空经常到github上看一下别人的开源代码,会有意想不到的收获及思路。

  1. 可读性
    可读性与代码作为文本文件的格式化方式有关。当所有人都使用一样的缩进方式时,整个项目中的代码都会更加易于阅读。目前许多框架都提供了这么一个检测代码的插件,eslint也是一个不错的练习,如vue-cli在构建项目时也会问你是否开启eslint,个人觉得是个不错的养成代码良好风格的练习方式
  2. 多写注释
    很多时候我上个星期写的代码,这个星期就不记得了,所有多写注释十分重要
  3. 变量名和函数名
    变量名应为名词 如 car 或 person
    函数名应该以动词开始,如 getName()
    返回布尔类型值的函数一般以 is 开头,如 isEnable() 。
    变量和函数都应使用合乎逻辑的名字,不用担心长度。因为最终在生产环境下代码可以被压缩打包,例如webpack和gulp都提供了这些功能。
  4. 变量类型透明
    由于在 JavaScript 中变量是松散类型的,很容易就忘记变量所应包含的数据类型。合适的命名方式
    可以一定程度上缓解这个问题,但放到所有的情况下看,还不够。有三种表示变量数据类型的方式。
    //第一种方式:通过初始化指定变量类型
var found = false; //布尔型
var count = -1; //数字
var name = ""; //字符串
var person = null; //对象

初始化为一个特定的数据类型可以很好的指明变量的类型。但缺点是它无法用于函数声明中的函数参数。
//第二种方法:用指定数据类型的匈牙利标记法,这个标记法在脚本语言中很流行,曾经很长时间也是 JavaScript 所推崇的方式,"o" 代表对象, "s" 代表字符串, "i"
代表整数, "f" 代表浮点数, "b" 代表布尔型

var bFound; //布尔型
var iCount; //整数
var sName; //字符串
var oPerson; //对象

JavaScript 中用匈牙利标记法的好处是函数参数一样可以使用。但它的缺点是让代码某种程度上难以阅读,阻碍了没有用它时代码的直观性和句子式的特质。因此,匈牙利标记法失去了一些开发者的宠爱。
//第三种方法:用于指定类型的类型注释 类型注释放在变量名右边,但是在初始化前面。

var found /*:Boolean*/ = false;
var count /*:int*/ = 10;
var name /*:String*/ = "Nicholas";
var person /*:Object*/ = null;

类型注释维持了代码的整体可读性,同时注入了类型信息。类型注释的缺点是你不能用多行注释一次注释大块的代码,因为类型注释也是多行注释,两者会冲突 。
这三种常见指定变量数据类型的方法。每种都有各自的优势和劣势,要自己在使用之前进
行评估。最重要的是要确定哪种最适合你的项目并一致使用。

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

推荐阅读更多精彩内容