开发分享:代码风格
目录
1 可读性的意义
目的:提高效率
自己读,易修改
别人读,易理解
2 命名
2.1 有表达力
(1)有表达力的单词:
(2)有表达力的迭代器:user_i, member_i
简单的i,j,k
2.2 命名长短准则
名字长短准则:作用域越大、名字越长
2.3 不能有歧义
(1)布尔相关,加前缀:
is,can,should,has
(2)数量范围
min,max
(3)空间包含范围
first,last
(4)空间排除范围
begin,end
4 好看
(1)空行
(2)缩进
(3)注释
(4)语句顺序一致
5 注释
5.1 注释的作用
(1)更易理解代码
(2)记录思考过程
(3)为不好的命名做补充
(4)做标记提醒自己
5.2 怎么加注释好
(1)尽量简洁
(2)加测试用例,说明
(3)用专业名词,缩短解释
6 提升控制流可读性
6.1 谨慎选择控制流语句
(1)左变量,右常数
(2)简单逻辑用三目,复杂的拆成if/else
(3)尽量用while,而不是do/while
(4)尽量不用goto
(5)嵌套中,多用return
6.2 多中断循环
多用:
break
continue
return
7 别用长表达式
(1)拆分
(2)摩根定理简化
8 减小变量作用域
用闭包,减小变量作用域
变量定义,和变量使用,位置要近
9 抽取函数
大问题,拆分,成小问题
单独函数,分别测试,减小代码冗余
10 逻辑整理
先伪代码,再真实代码
11 减少代码量
最开始,先实现,不要过多设计
参考
https://github.com/CyC2018/CS-Notes/blob/master/notes/%E4%BB%A3%E7%A0%81%E5%8F%AF%E8%AF%BB%E6%80%A7.md
《便携可读代码的艺术》