如何避免自己写的代码成为别人眼中的一坨屎!

普通的工程师堆砌代码,优秀的工程师优雅代码,卓越的工程师简化代码。如何写出优雅整洁易懂的代码是一门学问,也是软件工程实践里重要的一环。笔者推荐三本经典的书籍《代码整洁之道 》、《编写可读代码的艺术》、《重构:改善既有代码的设计》,下文重点将从注释、命名、方法、异常、单元测试等多个方面总结了一些代码整洁最佳实践,大部分是笔者总结于以上三本书中的精华,也有部分是笔者工程实践的总结。篇幅有限,本文将总结性给出一些实践建议,后续会有文章来给出一些代码整洁之道的事例。

一、注释

  • 不要给不好的名字加注释,一个好的名字比好的注释更重要;
  • 不要“拐杖注释”,好代码 > 坏代码 + 好注释;
  • 在文件/类级别使用全局注释来解释所有部分如何工作;
  • 一定要给常量加注释;
  • 团队统一定义标记:
    • TODO 待处理的问题;
    • FIXME 已知有问题的代码;
    • HACK 不得不采用的粗糙的解决方案;
  • 在注释中用精心挑选的输入输出例子进行说明;
  • 注释应该声明代码的高层次意图,而非明显的细节;
  • 不要在代码中加入代码的著作信息,git可以干的事情不要交给代码;
  • 源代码中的html注释是一种厌物, 增加阅读难度;
  • 注释一定要描述离它最近的代码;
  • 注释一定要与代码对应;
  • 公共api需要添加注释,其它代码谨慎使用注释;
  • 典型的烂注释:
    • 不恰当的信息;
    • 废弃的注释;
    • 冗余注释;
    • 糟糕的注释;
    • 注释掉的代码;
  • 唯一真正好的注释是你想办法不去写的注释:
    • 不要有循规式注释,比如setter/getter注释;
    • 不要添加日志式注释,比如修改时间等信息(git可以做的事情);
    • 注释一定是表达代码之外的东西,代码可以包含的内容,注释中一定不要出现;
    • 如果有必要注释,请注释意图(why),而不要去注释实现(how),大家都会看代码;
    • 适当添加警示注释;

二、命名

  • 尽可能使用标准命名方法,比如设计模式,通用学术名词等;
  • 命名要找更有表现力的词:
    • 使用更专业的词,比如不用get而使用fetch或者download;
    • 避免空泛的名字,像tmp;
    • 使用具体的名字来细致的描述事物;
    • 给变量名带上重要的细节,比如加上单位ms等;
    • 为作用域大的名字采用更长的名字,作用域小的使用短名字;
    • 变量类型为布尔值表达加上is,has,can,should这样的词会更明确;
  • 变量名称长短应该与其作用域对应;
  • 别害怕长名称,长而具有描述性的名称比短而令人费解的名称好;
  • 函数名称应该说明副作用,名称应该表达函数,变量或类的一切信息,请不要掩盖副作用,比如CreateAndReturnXXX;

三、方法

  • 函数不应该有100行那么长,20行封顶最好:
    • if else while等控制语句其中代码块应该只有一行,也就是一个函数调用语句;
    • 函数的锁进层次不应该多于两层;
    • 一个函数只做一件事,一个函数不应该能抽象出另外一个函数;
  • 某个公共函数调用的私有函数紧随其后;
  • 最理想的参数是零参数,最长不要超过三个入参,尽量不要输出参数:
    • 如果函数传入三个及以上参数最好将其抽象为类;
    • 标识参数十分丑陋,向函数传入布尔值用于区分不同业务的做法很丑陋,应该拆分为多个函数;
  • 别返回null值,抛出异常或者返回特殊对象,尽量避免NPE;
  • 别传入null值;

四、异常与错误

  • 抽离try catch包含的代码块,其中代码块抽象为一个函数;
  • 抛出的每个异常,都应当提供足够的环境说明,已便判断错误的来源与处所;
  • 不要将系统错误归咎于偶然事件;

五、并发

  • 分离并发相关代码与其它代码;
  • 严格限制对可能被共享的数据的访问;
  • 避免使用一个共享对象的多个同步方法;
  • 保持同步区域微小,尽可能少设计临界区;

六、单元测试

  • 不要怕单元测试的方法名字太长或者繁琐,测试函数的名称就像注释;
  • 不要追求太高的测试覆盖率,测试代码前面90%通常比后面10%花的时间少;
  • 使用最简单的并且能够完整运用代码的测试输入;;
  • 给测试函数取一个完整性的描述性名字,比如 Test _;
  • 测试代码与生产代码一样重要;
  • 如果测试代码不能保证整洁,你就会很快失去他们;
  • 每个测试一个断言,单个测试中断言数量应该最小化也就是一个断言;
  • FIRST原则:
    • 快速 Fast;
    • 独立 Independent 测试应该相互独立;
    • 可重复 Repeatable 测试应当在任何环境中重复通过;
    • 自足验证 Self-Validating 测试应该有布尔值输出;
    • 及时 Timely 最好的方式是TDD;

七、代码结构

  • 代码行长度控制在100-120个字符;
  • 可能用大多数为200行,最长500行的单个文件构造出色的系统;
  • 关系密切的代码应该相互靠近:
    • 变量声明应该靠近其使用位置;
    • 若某个函数调用了另外一个,应该把他们放在一起,而且调用者应该放在被调用者上面;
    • 自上向下展示函数调用依赖顺序;
  • 应该把解释条件意图的函数抽离出来,尽可能将条件表达为肯定形式;
  • 不要继承常量,比如接口中定义常量,不要使用继承欺骗编程语言的作用范围规则;
  • 模块不应了解它所操作对象的内部情况;
  • DTO(Data Transfer Objects)是一个只有公共变量没有函数的类;
  • 对象暴露行为,隐藏数据;
  • 不要使用“尤达表示法” 如 if(null == obj),现代编译器对if(obj = null)这样的代码会给出警告;
  • 一般情况使用if else,简单语句使用三目运算符;
  • 通常来讲提早返回可以减少嵌套并让代码整洁;

八、设计

  • 类应该足够短小:
    • 类应该满足单一权责原则(SRP),类和模块只有一个修改理由;
    • 类应该只有少量的实体变量;
    • 类应该遵循依赖倒置原则 DIP(Dependency Inversion Principle),类应该依赖于抽象而不是依赖于具体细节;
    • 类中的方法越少越好,函数知道的变量越少越好,类拥有的实体变量越少越好;
  • 通过减少变量的数量和让他们尽量“轻量级”来让代码更有可读性:
    • 减少变量;
    • 缩小变量的作用域;
    • 只写一次的变量更好,如常量;
  • 最好读的代码就是没有代码:
    • 从项目中消除不必要的功能,不要过度设计;
    • 从新考虑需求,解决版本最简单的问题,只要能完成工作就行;
    • 经常性地通读标准库的整个API,保持对他们的熟悉程度;
  • 简单设计:
    • 运行所有测试;
    • 不可重复;
    • 表达了程序员的意图;
    • 尽可能减少类和方法的数量;
    • 以上规则按重要程度排列;
  • 无论是设计系统或者单独模块,别忘了使用大概可工作的最简单方案;
  • 整洁的代码只提供一种而非多种做一件事的途径,他只有尽量少的依赖。明确定义并提供尽量少的API;
  • 减少重复代码,提高表达力,提早构建,简单抽象;

九、小结

本文从注释、命名、方法,单元测试,并发等视角简单给出了一些最佳实践,下文我们会展开来从每个方面介绍更多的实践事例。相信每一个优秀的工程师都有一颗追求卓越代码的心,在代码整洁工程实践上你有哪些好的建议?数百人协作开发的代码如何保证代码整洁一致性?欢迎大家来讨论。

PS:如果觉得我的分享不错,欢迎大家随手点赞、转发。

原文:yq.aliyun.com/articles/598076?utm_content=m_51055

原文发布于微信公众号 - Java团长(javatuanzhang)

原文发表时间:2018-07-22

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏企鹅号快讯

Python条件控制之if

各位小伙伴 周一早 又开始了新的一周 不知道各位周末过的怎么样? 反正常老师是觉得睡不够啊 这是不是说明我还是个小伙?嘿嘿! 本周我们要进行Python的继续学...

23050
来自专栏一个会写诗的程序员的博客

Java新手极简指北手册

为什么我先拿“数据结构和算法”说事捏?这玩意是写程序最最基本的东东。不管你使用 Java 还是其它的什么语言,都离不开它。而且这玩意是跨语言的,学好之后不管在哪...

15310
来自专栏极客猴

Python 中各种时间类型的转换

我们编码过程中经常需要获取当前时间。当然, 这也离不开对时间类型进行转换运算。本文主要讲解 Python 各种时间类型之间的转换。

10520
来自专栏Linyb极客之路

如何避免自己写的代码成为别人眼中的一坨屎!

普通的工程师堆砌代码,优秀的工程师优雅代码,卓越的工程师简化代码。如何写出优雅整洁易懂的代码是一门学问,也是软件工程实践里重要的一环。笔者推荐三本经典的书籍《代...

15670
来自专栏开源优测

[快学Python3]日期和时间处理

概述 在python中, date、time、datetime类提供了一系列处理日期、时间和时间间隔的函数。 在Python里我们大致可以把其实现日期时间类分为...

29870
来自专栏java工会

Java 8 最佳技巧

239120
来自专栏iKcamp

翻译连载 | 第 10 章:异步的函数式(下)-《JavaScript轻量级函数式编程》 |《你不知道的JS》姊妹篇

原文地址:Functional-Light-JS 原文作者:Kyle Simpson-《You-Dont-Know-JS》作者 第 10 章:异步的函数式(下)...

20750
来自专栏JavaEdge

设计模式实战 - 简单工厂

最可能给八卦炉下达什么样的生产命令呢? 应该是给我生产出一个黄色人种(YellowHuman类) 而不会是给我生产一个会走、会跑、会说话、皮肤是黄色的人种 ...

13350
来自专栏Java技术栈

Java 10的10个新特性,将彻底改变你写代码的方式!

Java 9才发布几个月,很多玩意都没整明白,现在Java 10又要来了。。 这时候我真尼玛想说:线上用的JDK 7 甚至JDK 6,JDK 8 还没用熟,JD...

44580
来自专栏Linyb极客之路

十个面向对象设计原则

追求高内聚highly cohesive 和松耦合 loosely couple 的解决方案是面向对象设计基本核心原则。这里列出OO设计中十大原则:

20610

扫码关注云+社区

领取腾讯云代金券