有效掌握编程风格 - 问题所在

野火烧不尽,春风吹又生。

代码中不协调的编程风格,就像野草一样有顽强的生命力,永远除不尽;
聪明的程序员立刻发现,靠人肉去Review不是长久之计。

斩草除根,以绝后患。

于是Lint这样的静态代码检查工具中必不可少的一项就是编程风格,大家期望在流程中加一道关卡以一劳永逸地解决该问题。

堵不如疏

风格要保持一致

大家在编码或Review代码时,发现风格不协调很容易,凭本能就能做到,于是达成了第一条共识:在同一上下文内风格要保持一致。这个上下文灵活性也可以很大:从同一种编程语言要保持同一种风格,到同一个项目内,还可以小到同一个源文件内,甚至同一个函数内。一切全凭Review代码时的心情。

还是不服

风格保持一致,并没有解决问题,总有人跳出来抱怨受不了前任的代码风格。

不患寡而患不均

争论到了这个层次,事情本身-编程风格是什么已经不重要,重要的是-为什么是你的,而不是我的

知其然,知其所以然

好的编程风格指南长什么样

  • 告知WHY
    好的编程风格会明确告诉你规约产生的背景及要解决的问题。
    如Angular的Style Guide对每个Style都有Why?的条目解释;
    Alibaba的Java Coding GuidelinesNote条目。
  • 分级
    不是每条规约都一样重要,可适当抓大放小。
    如Alibaba的Java Coding Guidelines依据约束力强弱及故障敏感性分为三个等级:Mandatory, Recommended and Reference
    Angular的Style Guide则分为DoConsider两级。
  • 给出正反例
    一图胜千言,一个例子可以让大家秒懂这条规约。
    如Google Java Style Guide有正例和Exception例子;
    Angular Style Guide有正例和avoid例子;
    Alibaba的Java Coding GuidelinesPositive exampleCounter example

问题解决了吗

这样的风格指南像法律条文一样,做为编程智慧的结晶,倒是解决了争议的问题。
知法犯法的问题也有执法机构来解决,可不知法呢?

TBC

有效掌握编程风格 - 命名规范

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

推荐阅读更多精彩内容