代码大全学习笔记——第十一章变量名的力量3
分类:
文章
•
2025-01-30 14:38:40
11.5 标准前缀
标准化的前缀由两部分组成:用户自定义类型(UDT)的缩写和语义前缀
用户自定义类型缩写
个人理解:用户自定义类型是用户根据自己编程中的需求自己定义的(与编程语言无关的)特定的用于区分的类型
语义前缀


标准前缀的优点
- 提供标准化,因此需要记忆的名字更少
- 标准化的前缀使名字变得更加紧凑
11.6 创建具备可读性的短名字
缩写的一般指导原则
- 使用标准的缩写
- 去掉所有非前置元音(computer变成cmptr, screen变成scrn, apple变成appl, integer 变成intgr)
- 去掉虚词and or the等
- 使用每个单词的第一个或前几个字母
- 统一地在每个单词的第一、第二或者第三个(选择最合适的一个)字母后截断
- 保留每个单词的第一个和最后一个字母
- 使用名字中的每一个重要单词,最多不超过三个
- 去掉无用的后缀——ing,ed等
- 保留每个音节中最引人注意的发音
- ** 确保不要改变变量的含义**
- 反复使用上述技术,直到你把每个变量名的长度缩减到了8到20个字符,或者达到你所用的编程语言对变量名的限制字符数
语音缩写(感觉很扯)
有关缩写的避免犯错的规则
- 不要用从每个单词中删除一个字符的方式来缩写
- 缩写要一致,应该一直使用相同的缩写
- ** 创建你能读出来的名字**
- 避免使用容易看错或者读错的字符组合
- 使用辞典来解决命名冲突
- 在代码里用缩写对照表(即在注释中解释缩写的意思)解释极短的名字的含义
- 在一份项目级的“标准缩写”文档中说明所有的缩写:为了使所有的阅读者和编写者都能够统一的使用和清除缩写名字的含义,那么就可以将缩写标准化
- 记住,名字对于代码读者的意义要比对作者更重要
11.7 应该避免的名字
- 避免使用令人误解的名字或缩写
- 避免使用具有相似含义的名字
- 避免使用具有不同含义但却有相似名字的变量
- 避免使用发音相近的名字:其实个人的理解,没必要吧,俩程序员不会没事撑得去互相说两个名字吧
- 避免在名字中使用数字
- 避免在名字中拼错单词
- 避免使用英语中常常拼错的单词
- 不要仅靠大小写来区分变量名
- 避免使用多种自然语言
- 避免使用标准类型、变量和子程序的名字:这个没必要列吧,我用的c c++ 等关键字是不能使用的啊
- 不要使用与变量含义完全无关的名字
- 避免在名字中包含易混淆的字符
要点
- 好的变量名是提高程序可读性的一项关键要素
- 名字要尽可能地具体
- 命名规则应该能够区分局部变量、类数据和全局数据
- 无论做那种类型项目,你都应该采用某种变量命名规则
- 现代编程语言很少需要用到缩写
- 代码阅读的次数远远多于编写的次数