编写可读代码的艺术(三)不要起误解的名字以及代码上的‘审美’
2018-02-23 22:12
411 查看
当我们将信息装进名字里,不免会导致一个问题的出现-那是该名字是否让其他人产生歧义或者误解,所以我们应该主动发现所谓的误解点并修正更改
例如避免使用filter(不知道是挑选(可以使用choose)还是过滤(screen_out))和clip(不知道是从尾部还是哪里剪切掉)等二义词
当用到极限或者边缘性范围的,不要使用limit这样的歧义词,推荐使用min/max(【包含】极限),first/last(【包含】范围),begin/end(【包含/排除】范围)这些解释性词义作为前缀进行解释
对于一些先入为主的歧义词我们应该与使用者的期望相匹配,比如:get*()方法习惯上试作为一种轻量级访问器的使用,它只是简单返回一个内部成员的变量,如果像getMean()是实现遍历所有数据且加以计算中值,可能导致其他人随意误用付出一定的代价
代码结构上的审美性有三大原则:第一,使用一致的布局风格;第二,让相似的代码看上相似;第三,把相关的代码行分组,形成代码块。
具体的技巧:1如果多个代码块做相似的事情,尝试让他们有相同的剪影;2把代码按“列”对齐可以使代码更容易浏览;3如果在一段代码上提到A,B和C,在另一段上也使用相同顺序,即选择一个有意义的顺序,并始终使用下去;4用空行将代码块按逻辑分成“段落”
例如避免使用filter(不知道是挑选(可以使用choose)还是过滤(screen_out))和clip(不知道是从尾部还是哪里剪切掉)等二义词
当用到极限或者边缘性范围的,不要使用limit这样的歧义词,推荐使用min/max(【包含】极限),first/last(【包含】范围),begin/end(【包含/排除】范围)这些解释性词义作为前缀进行解释
对于一些先入为主的歧义词我们应该与使用者的期望相匹配,比如:get*()方法习惯上试作为一种轻量级访问器的使用,它只是简单返回一个内部成员的变量,如果像getMean()是实现遍历所有数据且加以计算中值,可能导致其他人随意误用付出一定的代价
代码结构上的审美性有三大原则:第一,使用一致的布局风格;第二,让相似的代码看上相似;第三,把相关的代码行分组,形成代码块。
具体的技巧:1如果多个代码块做相似的事情,尝试让他们有相同的剪影;2把代码按“列”对齐可以使代码更容易浏览;3如果在一段代码上提到A,B和C,在另一段上也使用相同顺序,即选择一个有意义的顺序,并始终使用下去;4用空行将代码块按逻辑分成“段落”
相关文章推荐
- 编写可读代码的艺术读书笔记--审美与注释
- 编写易读代码的艺术——第三章 名字应不能被误解
- 编写可读代码的艺术读书笔记--把信息装到名字里
- 编写可读代码的艺术chapter 10-13
- 编写易读代码的艺术——第二章 把精确包含到名字里
- 编写可读代码的艺术
- 读<<编写可读代码的艺术>>总结
- 编写可读代码的艺术(七)测试的可读性
- 编写可读代码艺术笔记
- 编写可读代码的艺术
- 编写可读代码的艺术chapter 1-6
- 读书笔记-编写可读代码的艺术[上]
- 编写可读代码的艺术(四)注释的“艺术性”
- 编写可读代码的艺术----读书笔记
- 读书笔记-编写可读代码的艺术[上]
- O’Reilly精品图书系列:编写可读代码的艺术].(鲍斯维尔等).尹哲等
- 编写可读代码的艺术 读后感(一)
- 读书笔记-编写可读代码的艺术[上]
- 编写可读代码的艺术 读后感(二)
- 编写可读代码的艺术 读后感(三)