编写可读代码的艺术----读书笔记

1.函数或者变量命名时不用get,用fetch或者download会更好。
2.避免使用空泛的名字,如tmp,retval等。
3.作用域大的变量名字要长一些。
4.使用专业的单词,例如使用fetch而不用get
5.当为布尔值命名时,使用is和has这样的词来表示它是布尔值。
6.要小心用户对特定词的期望,例如,用户期望get()和size()是轻量级的方法。
7.用空行把大块代码分成逻辑上的段落。
8.写注释的时候如果不好描述,可以举个例子写上。
9.注释要写代码写成这样的原因,而不是代码的表面意思。
10.给代码块加上注释,使读者不致迷失在细节中。
11.比较表达式中左侧是变化的,右侧是不变的常量。
12.if/else语句中,把简单、正确的放在前面写,尽量让if和else离得近。
13.减少嵌套,可以通过return返回来减少嵌套。
14.拆分表达式,把其中一段表达式赋值给一个“解释变量”,让这个简单的名字来描述表达式。
15.减少定义变量的个数。
16.在一段代码中,应该尽量减少对变量修改的次数。
17.减小每个变量的作用域。
18.一次只做一件事。
19.用自然语言描述程序要做的事,然后写出代码。把一个问题变成语言真的可以让它更具体。
20.实现一个功能的代码越少越好,可以通过消除不必要的功能解决。

猜你喜欢

转载自blog.csdn.net/qq_16209077/article/details/79187191