本文主要是介绍《代码整洁之道:CleanCode》学习总结,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
- 概括总结:
- 整洁代码:
培养整洁代码的意识,经常维护项目中的模块保持整洁。整洁的代码增强可维护性,并且能提高工作效率。
2.有意义的命名:
名副其实的命名,变量名,函数,类名等。命名也有意义且能让人读懂。错误示例:名字没有含义,a1 a2。
3.函数:
函数要单一,并且只做一件事。这样不容易出错,并且好复用,可维护性强大。
4.注释:
尽量不写注释,注释不要有废话,注释最后的作用是提供有用的信息。
5.格式:
保持项目中的风格格式统一,便于团队开发,并且阅读代码方便,也有美感。
6.对象和数据结构:
对象和数据结构是两个概念,写代码的时候,尽量拆分开,不要混在一起。
7.错误处理:
错误处理要调用方便,不要和逻辑业务耦合在一起。
- 开发中的实践运用:
(1)整洁代码:
- 整洁代码是美观的,并且可读性强
- 整洁的代码,意义清晰,直观,可维护性强
- 没有重复的代码,尽量短小的实体
- 经常维护代码的整洁,碰到修改的模块,要顺手修改
- 培养代码整洁的意识
(2)有意义的命名:
- 变量名不要太相近,容易混乱。
- A1a2的区分没有意义,并且容易乱,要起个排列的名字进行区分。
- 变量名不要是废话,比如叫变量,叫class,叫list,要有意义。
- 起名要方便读和认,不要起很奇怪的名字。
- 起名字要有特殊性,不要太大众,不便于搜索。
- 遵循驼峰命名法
- 全局变量和局部变量,又要命名区分。比如全局带m。
- 有些特定的名字,就不要来命名变量了,比如i,j等。
- 类名要短小,不要太长,函数名要是动词or动词 短语。
(3)函数:
- 函数要短小精悍,越短越好。
- 封装的逻辑只处理单一,不要混杂在一起。
- Switch使用要避免重复。
- 函数要有个好名字,参见命名(1)。
- 参数要少,很多参数可以封装成对象传递。
- 尽量避免,一元函数,一般处理event,需要有返回值。
- 参数尽量不要为boolean,把两个处理封装成两个函数。
- 函数为动词命名。
- 抽离trycatch代码块,函数返回错误码。
- 相同作用的代码,抽成共用函数。
(4)注释:
- 少些注释,良好的命名,就不太需要写注释。
- 做好判断逻辑的函数封装,可以少写注释。
- 注释是来提供信息(约定俗成的信息等)。
- 阐述逻辑。
- TODO注释,添加工作列表。
- 不要写多余无用的注释。
(5)格式:
- 代码从上到下排列,变量,函数等。
- 相同属性的代码之间,可以关系更紧密,没有空行,比如变量。
- 项目格式化文件,敲代码的时候,多用,保持风格一致,缩进,排列。
(6)对象和数据结构:
- getset封装的是本地,具体实现是私有不可见的。
- 面向对象和面向过程,看情况选择,并不是某种就特别好。
- 迪米特Demeter法则,模块操作对象,不需要了解对象内的数据实现。
- 避免火车失事写法,即:一连串的函数调用。
- 避免混杂,对象和数据结构要分开。
(7)错误处理(强固又整洁的代码):
- 根据返回码对应处理相应的情况,不要和逻辑掺杂在一起。
- 可能会抛出异常的代码,需要使用try-Catch-finally捕捉。
- 使用不可控异常处理,可控异常处理维护成本高。
- 在异常可能发生的代码,添加日志记录操作行为,便于修改问题。
- 记录异常时,可以直接记录错误类型,不用根据不同的错误类型打印日志,减少无用代码。
- 异常处理需要添加开关,可以选择处理异常,也可以不处理。
- 异常处理,不要返回null。增加了判空和后续调用的工作量。
- 参数不要传null,容易空异常崩溃,还要添加判空处理。
这篇关于《代码整洁之道:CleanCode》学习总结的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!