代码整洁之道:你的代码是否足够优雅、整洁、易懂?

发布时间2018/9/18 20:09:48

下载次数 0 次 访问量115 次

普通的工程师堆砌代码,优秀的工程师优雅代码,卓越的工程师简化代码。如何写出优雅整洁易懂的代码是一门学问,也是软件工程实践里重要的一环。下面从注释、命名、方法,并发等视角简单给出了部分最佳实践。相信每一个优秀的工程师都有一颗追求卓越代码的心。

注释
不要给不好的名字加注释,一个好的名字比好的注释更重要
不要“拐杖注释”,好代码 > 坏代码 + 好注释
在文件/类级别使用全局注释来解释所有部分如何工作
一定要给常量加注释
团队统一定义标记
TODO 待处理的问题
FIXME 已知有问题的代码
HACK 不得不采用的粗糙的解决方案

命名
尽可能使用标准命名方法,比如设计模式,通用学术名词等
命名要找更有表现力的词
使用更专业的词,比如不用get而使用fetch或者download
避免空泛的名字,像tmp
使用具体的名字来细致的描述事物
给变量名带上重要的细节,比如加上单位ms等
为作用域大的名字采用更长的名字,作用域小的使用短名字
变量类型为布尔值表达加上is,has,can,should这样的词会更明确

image

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

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

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

一起来讨论下:
1、在代码整洁工程实践上你有哪些好的建议?

2、数百人协作开发的代码如何保证代码整洁一致性?

3、你的代码属于哪一种境界?是否会去追寻代码整洁之道?

网友评论

发表评论

欢迎评论哦!