1.调整心态
认识到编写可读代码的必要性。在编写可拓展代码，可用代码和可读代码之间的优先级，编写可读代码较高；
克服思想上的惰性，尤其是写代码的过程中思维比较流畅，不想停下来想方法或者变量名的时候；
克服第二点的方法一部分定义团队命名规则：mysql中取数据，redis中取数据，MongoDB中取数据，定义统一规范，减少很多无谓思考命名时间
2.代码应该易于理解，首先明确什么叫做易于理解？命名符合阅读者的习惯。
名称包含内容+功能：首先功能是：增（add,set）删(delete)改(update)查(get,select)，组装对象(build)，容器比如上下文(context)；内容：比如订单，施肥，爱心等
其中功能可以定义，内容按照需要粒度不同，粒度细一些更好，比如更新订单粒度下到具体更新哪个字段
选择专业的词：这个建议统一定义规范，中国人对于英语单词的语气粒度把握不准
避免选择泛泛的名字，有些方法想要定义的尽可能通用，命名的时候需要多思考一下，是否可以更加明确一些
使用具体的名字细致的描述事物
给变量名带上重要的细节，比如静态变量大写加上下划线"_"
名字的长短和作用于有关：如果某个方法作用于比较广，比如提供给外部使用的方法，尽可能多的描述信息，降低别人理解成本
有目的的使用大小写和下划线：这个团队统一规范比较好
3.不会误解的名字
first/last：左闭右闭
begin/end：左闭右开
给bool值命名，含义明确
一个函数的调用代价如何通过函数名初步体现
get*() 一般用作轻量级访问， 有些计算是重量级访问
4.审美
重新安排换行来保持一致和紧凑
代码块职责明确，功能单一
拆分比较长的表达式
熟悉函数库
5.逻辑
最小化嵌套，及时返回
if-else先考虑正逻辑
6.注释
合适的注释，代码和注释是互补的，不是重合的
代码写清楚做了什么，注释写清楚为什么这么做，界限在哪
如果用到设计模式，或者自定义数据结构，写清楚为什么这么设计，优势和缺点是什么
网友评论