Clean Code 代码检查清单
- 注释:
- 不恰当的信息:注释只应该描述有关代码和设计的技术性信息。
- 废弃的注释:过时、无关或不正确的注释就是废弃的注释。
- 冗余注释:注释应该谈及代码自身没提到的东西
- 糟糕的注释:值得编写的注释,也值得好好写。
- 注释掉的代码
- 环境:
- 需要多步才能实现的构建:构建系统应该是单步的小操作。
- 需要多步才能做到的测试:应当能够发出单个指令就可以运行全部单元测试。能够运行全部测试是如此基础和重要,应该快速、轻易和直截了当地做到。
- 函数
- 过多的参数,没参最好
- 输出参数:输出参数就违反直觉。如果函数非要修改什么东西的状态不可,就修改它所在对象的状态好了。
- 标识参数:布尔值参数大声宣告函数做了不止一件事。
- 死函数:永不被调用的方法应该丢弃。别害怕删除函数。
- 一般性问题:
- 一个源文件中存在多种语言:理想的源文件包括且只包括一种语言,应该尽力减少源文件中额外语言的数量和范围。
- 明显的行为未被实现:最小惊异原则--函数或类应该实现其他程序员有理由期待的行为。
- 不正确的边界行为:别依赖直觉。追索每种边界条件,并编写测试。
- 忽视安全:关闭失败测试、告诉自己过后再处理,这和假装刷信用卡不用还钱一样坏。
- 重复:核心原则。每次看到重复代码,都代表遗漏了抽象。
- 在错误的抽象层级上的代码:只与细节实现有关的常量、变量或工具函数不应该在基类中出现。
- 基类依赖于派生类:例外情况是派生类数量严格固定。
- 信息过多:设计良好的模块有着非常小的接口,让你能事半功倍。设计良好的接口并不提供许多需要依靠的函数,所以耦合度也较低。设计低劣的接口提供大量你必须调用的的函数,耦合度较高。隐藏你的数据。隐藏你的工具函数。隐藏你的常量和你的临时变量。不要创建拥有大量方法或大量实体变量的类。不要为子类创建大量受保护变量和函数。尽量保持接口紧凑。通过限制信息来控制耦合度。
- 死代码:死代码就是不执行的代码。
- 垂直分隔:变量和函数应该在靠近被使用的地方定义。
- 前后不一致:从一而终,小心选择约定,一旦选中,就小心持续遵循。
- 混淆视听:
- 人为耦合:不互相依赖的东西不该耦合。
- 特性依恋:类的方法只应对其所属类中的变量和函数感兴趣,不该垂青其他类中的变量和函数。
- “选择算子”参数:“选择算子”参数只是一种避免把大函数切分为多个小函数的偷懒做法。选择算子不一定是boolean类型,可能是枚举元素、整数或任何一种用于选择函数行为的参数。
- 晦涩的意图:代码要尽可能具有表达力。
- 位置错误的权责:软件开发者做出的最重要决定之一就是在哪里放代码。(最小惊异原则)代码应该放在读者自然而然期待它所在的地方。
- 不恰当的静态方法:恰当的静态方法不应在单个实体上操作。
- 应当使用解释性变量:让程序可读的最有力的方法之一就是将计算过程打散成在用有意义的单词命名的变量中放置的中间值。
- 函数名称应该表达其行为:
- 理解算法:“可以工作”是不行的,必须知道解决方案是正确的。
- 应当把逻辑依赖改为物理依赖:依赖者模块不应对被依赖者模块有假定。
- 应当用多态替代if/else或switch/case: 在使用if/else或switch/case前,先考虑使用多态。
- 遵循标准约定:
- 用命名常量替代魔术数:
- 准确:
- 结构甚于约定:坚守结构甚于约定的设计决策。命名约定很好,但却次于强制性的结构。
- 封装条件:应该把解释了条件意图的函数抽离出来。
- 避免否定性条件:
- 函数只做一件事:
- 不要掩蔽时序耦合:通过创建时序队列暴露时序耦合。
- 应当封装边界条件:
- 函数应当只在一个抽象层级上:(拆分不同抽象层级是重构的最重要的功能之一)
- 应当在较高层级放置可配置数据
- 避免传递浏览:确保模块只了解其直接协作者。
- Java
- 通过使用通配符避免过长的导入清单:(这一项由IDE来实现)
- 不要继承常量:
- 常量 VS. 枚举 :优先用枚举
- 采用描述性名称:
- 名称应与抽象层级相符
- 尽可能使用标准命名法:
- 无歧义的名称:
- 避免编码:不应在名称中包括类型或作用范围信息。
- 名称应该说明副作用:名称应该说明函数、变量或类的一切信息。
- 测试:
- 测试不足:
- 使用覆盖率工具:覆盖率工具能汇报你测试策略中的缺口。
- 别略过小测试
- 被忽略的测试就是对不确定事物的疑问:需求不明确而不能确定某个行为细节,可以用注释掉的测试或者用@Ignore标记的测试来表达我们对于需求的疑问。
- 测试边界条件
- 全面测试相近的缺陷
- 测试失败的模式有启发性
- 测试覆盖率的模式有启发性
- 测试应该快速
Clean Code 代码检查清单的更多相关文章
- 读《Clean Code 代码整洁之道》之感悟
盲目自信,自认为已经敲了几年代码,还看什么整洁之道啊.我那可爱的书架读懂了我的心思,很明事理的保护起来这本小可爱,未曾让它与我牵手 最近项目中的 bug 有点多,改动代码十分吃力,每看一行代码都带一句 ...
- Clean Code 代码整洁之道
军规:让营地比你来时更干净. 整洁代码 Leblanc : Later equals never. (勒布朗法则:稍后等于永不) 对代码的每次修改都影响到其他两三处代码. 修改无小事. 如同医生不能遵 ...
- OC静态代码检查实战
此文已由作者杨晓授权网易云社区发布. 欢迎访问网易云社区,了解更多网易技术产品运营经验. 在Mac OS系统上,采用Xcodebuild Analyze命令和OClint工具,对iOS项目进行静态代码 ...
- 《Clean Code》 代码简洁之道
作者介绍 原文作者: Robert C. Martin, Object Mentor公司总裁,面向对象设计.模式.UML.敏捷方法学和极限编程领域的资深顾问,是<敏捷软件开发:原则.模式.与实践 ...
- 《代码整洁之道》(Clean Code)- 读书笔记
一.关于Bob大叔的Clean Code <代码整洁之道>主要讲述了一系列行之有效的整洁代码操作实践.软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关.这一点,无论是敏捷开发流派 ...
- Clean Code之JavaScript代码示例
译者按: 简洁的代码可以避免写出过多的BUG. 原文: JavaScript Clean Code - Best Practices 译者: Fundebug 本文采用意译,版权归原作者所有 引文 作 ...
- 代码整洁之道Clean Code笔记
@ 目录 第 1 章 Clean Code 整洁代码(3星) ?为什么要整洁的代码 ?什么叫做整洁代码 第 2 章 Meaningful Names 有意义的命名(3星) 第 3 章 Function ...
- 《clean code》讲述代码中的道,而不是术
Clean code 看<clean code>一书,学习高手写出的代码,简单高效的代 1.目标 Bjarne Stroustrup:优雅且高效:直截了当:减少依赖:只做好一件事 Grad ...
- 程序员必备的代码审查(Code Review)清单【转载】
在我们关于高效代码审查的博文中,我们建议使用一个检查清单.在代码审查中,检查清单是一个非常好的工具——它们保证了审查可以在你的团队中始终如一的进行.它们也是一种保证常见问题能够被发现并被解决的便利方式 ...
随机推荐
- 题解 CF1097F 【Alex and a TV Show】
妙妙题-- 这道题这要求%2的个数,肯定有什么性质 于是我们想到了用\(bitset\)来处理 由于三操作有\(gcd\),于是我们又想到用反演来解决 我们回忆一下反演的柿子 设\(f(x)\)为x出 ...
- 数据科学速查手册(包括机器学习,概率,微积分,线性代数,python,pandas,numpy,数据可视化,SQL,大数据等方向)
介绍:https://redstonewill.com/2372/ 项目网址:https://github.com/FavioVazquez/ds-cheatsheets
- [java][JEECG] Maven settings.xml JEECG项目初始化 RouYi settings.xml配置
好吧一下是经验之谈,原本这些坑不应该躺的,从头看手册完全可以避免这些. 懒得整理了,看懂了就看,看不懂自己琢磨JEECG的帮助文档去,不过嘛我喜欢用Intelij IDEA,他里面都是别的IDE,不喜 ...
- 基于腾讯云监控 API 的 Grafana App 插件开发
Tencent Cloud Monitor App Grafana 是一个开源的时序性统计和监控平台,支持例如 elasticsearch.graphite.influxdb 等众多的数据源,并以功能 ...
- hive 属性随笔记录
set hive.mapred.mode=strict; //设置hive执行模式,默认为nonstrict(非严格模式),这里设置为严格模式 set hiveconf:hive.cli.print. ...
- HikariCP 连接最快的连接池
三点原因 1.字节码精简 2.自定义 FastList 代替ArrayList ;避免每次get()调用都要进行range check,避免调用remove()时的从头到尾的扫描: 3.优化代码和拦截 ...
- html5的source元素
html5的source元素 一.总结 一句话总结: 主要是解决视频播放时候的浏览器的兼容问题 二.html5的source元素 学习要点 掌握source元素的用法 source元素-解决浏览器额兼 ...
- Tensorflow 2 模型默认保存路径
Tensorflow 2 模型默认保存路径 商务合作,科技咨询,版权转让:向日葵,135-4855__4328,xiexiaokui#qq.com 保存: import datetime now=da ...
- H5网站接入支付宝的支付接口
写本文章的目的是为了记录工作中遇到的问题,方便以后遇到可以迅速解决问题 H5手机网站接入支付宝的支付接口,推荐使用支付宝提供的SDK来快速开发 我使用的是SDK开发 引用命名空间 using Aop. ...
- invalid application of ‘sizeof’ to incomplete type
sizeof 后面所跟的数据类型没有定义,或者找不到定义的地方 eg: 头文件中定义结构体如下: struct PersonaL{ char name[]; int age; }; 但是在cpp中使 ...