写让别人看的懂得代码

来到赤子城之后, 学到了很多代码风格层面的东西, 结合之前看博客论坛啥的, 一起来给大家总结一下.
码代码,我们需要让机器看懂, 当然我们更需要方便别人阅读 -- 本是同根生相煎何太急.

写让别人看的懂得代码

两个原则

  • DRY(Don`t repeat yourself)
    • 代码少,bug就会相对来说少.
    • 重复代码少,维护容易.
  • TED
    • Terse 简洁
    • Expressive 具有表达力
    • Do one thing 只做一件事情

一些具体的表现

  • 如果你试图写一段注释,从某种角度来看,你正在试图写一段别人无法理解的代码.拒绝注释!用方法名,变量名来代替注释.
  • 如果你在命名方法名的时候,企图用or,and,if...很可能你在此方法中不止做了一件事,违反了Do one thing!
  • 如果出现如下代码if(age > 18).那就要注意了,鬼知道18代表什么意思.所以我们一般都会为这种赋予一个变量adult = 18
  • 双重否定!!!if(!notMe).你这是在浪费我的脑细胞么?
  • 代码写成火箭.
  • HardCode问题! if(name == "noodles") --> if(name == Name.Noodles)
  • 返回Boolean的问题
boolean isAdult(int age){
    boolean isAdult;
    if(age > 18){ //--> 上面说过这个问题
        isAdult = true;
    }else{
        isAdult = false;
    }
    return isAdult;
}

改成如下代码

boolean isAdult(int age){
    return  age > 18;
}
  • 复杂的条件判断if(baba || baba && baba) --> if(isBa())
  • 嵌套判断! 如果在判断耨一个条件,应该遵循知道了结果尽早返回的思想.
  • 参数过多!void register(string name,string password,String phone) --> void register(User user)
  • 方法中有boolean参数 public void RegisterUser(User user, bool sendEmail){} --> public void RegisterUser(User user),public void SendEmail(User user)

写可扩展的代码

写可测试的代码

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,612评论 18 399
  • 你为什么要离开我?你是不是不爱我了? 不是,正是因为我太爱你了,我才要离开你。我给不了你美好的未来,你要好好的。
    MorningBaby阅读 152评论 0 0
  • 1.基于虚拟金币的交换或者促销的一些展示(例如:有大白的图片)需要授权才可以使用,虚拟金币需要用到苹果的内购才可以...
    小孩仔阅读 1,628评论 0 1
  • 使用native-echarts 具体的配置项可看echarts的官网Echarts网站 npm installn...
    0安阅读 2,120评论 0 0