格式

引言

        代码格式决定读者对代码质量最初的判断。好的格式能够增强代码的可读性,并且能让读者阅读代码的时候心情愉悦。

格式的目的

       代码格式关乎沟通。我们很多人在编写代码的时候更关注功能实现的正确性,往往认为功能正确就已经几近成功。可是在我们完成第一个版本后,我们写的这些代码极有可能会被修改,而代码格式与代码的可读性是成正比关系,代码风格会极大的影响到项目的可维护性和扩展性。

       我们将从垂直格式和水平格式来谈谈如何可以更好的沟通。

垂直格式

源文件层次

       源文件的名称应该简单、明了,其名称本身应该告诉我们是否在正确的模块中。源文件的顶部位置应该给出高层次的概念和算法,具体的实现细节应该在后面依次展开

概念间垂直方向上的间距

       代码的阅读都是遵从自上而下、从左至右的的顺序。在代码中适当的插入些空白行可以极大的增强阅读代码时的视觉感受。比如:

每一空白行都暗示着一个线索,标识出新的独立概念。在阅读时很容易就会将目光停留在空白行之后的那一行,如果抽掉那些空白行,代码的可读性就会弱很多。

垂直距离

      同一文件中函数调用,相互调用函数的应该在垂直方向上尽可能的靠近。在vscode中查看js代码时,如果调用双方距离较远时,经常会出现当我需要查看被调用方法时按ctrl+f去搜索,而当查看完后又要用ctrl+f搜索回来,极为耗时。因此,若某个函数调用了另外一个,就应该把他们放在一起,而且调用者应该放在被调用者上面,这样程序就有个自然的 顺序。如果能够坚持这条规则,那么读者就能知道函数声明很快就会在其调用后面出现,从而可以减少ctrl+f的次数。在非调用关系的函数之间也应该保证函数的顺序性。此外,概念相关的代码应该放在一起。相关性越强,彼此之间的距离就该越短。

横向格式

水平方向上的区隔与靠近

       在编程的过程中,我们比较喜欢用空格符将一些紧密相关的事物连接到一起,有时候也用空格符把相关性较弱的事物分割开。 比如我们在赋值的时候通常会如:int a = 10这样将等号两边加上空格符以达到强调的作用,达到了分隔的效果。

水平对齐和缩进

       如今一般IDE都会帮我们自动做这两件事儿,但是还是要强调同一层级的语句首字符要位于同一垂直线上。

结尾

       在编写代码时要保证良好的代码格式,应该选用一套简单的管理代码格式的规则,并在整个项目中贯彻这一规则。整个团队也应该采用同一套规则,并且所有从成员都要遵从这一规则。

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