概述
最近在读Clean Code英文原版,入行两年,也该开始逐步提升自己的代码质量了(避免被人吐槽像XX一样的code),以此为记,鞭策自己努力像一个正儿八经的程序媛迈进!
关于命名
- 优雅的代码: 通过所有的测试 没有重复 尽量少的实体,如类、方法、函数等
- 命名原则 名副其实: 名字所表达的具体含义、类型清楚 避免误导:避免使用具有特殊意义的字段,避免使用相近的命名造成误导 有意义的区分:如productInfo 和 productData 虽然名称不同,却不具有区分性
- 使用具有可读性的名称,便于搜索
- 避免使用编码
- 类名或对象名应使用名词或名词短语,不应使用动词
- 方法名应使用动词或动词短语,必要时使用get set is 前缀
- 避免使用双关语,如在像数组中插入元素时,使用insert或append,而不要使用add
- 添加有意义的语境而避免使用无意义的语境
关于函数(方法)
- 短小
- 只做一件事,并做好这件事
- 每个函数一个抽象层级,自顶向下阅读的规则
- 开放封闭原则:软件实体应该是可扩展,而不可修改的。也就是说,对扩展是开放的,而对修改是封闭的。
- 使用描述性的名称,不惧怕使用长名称
- 尽量少的使用参数,避免使用三个以上的参数,尽量将二元参数转化为一元,不得不传多元参数时,尽量将其封装成一个对象。
- 无副作用,降低耦合,尤其是时序性耦合
- 分隔指令与询问,即查询某对象的相关信息与修改某对象的相关信息应分开
- 用异常替代返回错误代码,将错误处理从主函数路径中分离出来 消灭重复代码
- 结构化编程原则:自顶向下,逐步细化;清晰第一,效率第二;书写规范,缩进格式;基本结构,组合而成。
- 不惧怕代码重构,不断优化
仅供参考,欢迎各路大神批评指正,小女子在此谢过!
转载于:https://juejin.im/post/5c4414696fb9a049e93d08fb
最后
以上就是大方万宝路为你收集整理的Clean code 笔记 - 优雅的代码(1)—— 代码命名和函数编写的基本原则的全部内容,希望文章能够帮你解决Clean code 笔记 - 优雅的代码(1)—— 代码命名和函数编写的基本原则所遇到的程序开发问题。
如果觉得靠谱客网站的内容还不错,欢迎将靠谱客网站推荐给程序员好友。
本图文内容来源于网友提供,作为学习参考使用,或来自网络收集整理,版权属于原作者所有。
发表评论 取消回复