命名整理

1、名副其实:就是找到最为合适的命名方式,并且能够通过类名,方法名,变量名等就能知道这段代码的作用是什么。它该告诉你,它为什么会存在,它做什么事,应该怎么用。
2、避免误导:必须避免留下掩藏代码本意的错误线索。应当避免使用与本意相悖的词。不使用有特殊意义的词。提防使用不同之处较小的名称。不使用类似l和O之类的与数字相近的字母命名。
3、做有意义的区分:例如有两个不同的东西,但是可以用同一个词来命名,这时候要注意用有意义的区分方式区分。废话都是冗余的。
4、使用读得出来的名称:不要自己造词,而应该使用恰当的英语词。
5、使用可搜索的名称:单字母名称和数字常量很难在一大篇文字中找出来。其中短字母仅用于短方法中的本地变量。名称长短应与其作用域大小相对应。
6、避免使用编码:1)匈牙利语标记法(过时);2)成员前缀(人们开始无视它了,只注意想要的信息);3)接口和实现(不加修饰的命名)。
7、避免思维映射:不应当让读者在脑中把你的名称翻译为他们熟知的名称。单字母变量名中例如,循环计数器i、j或k等,使得其他使用它的人要映射为真实的概念。明确是王道。
8、类名和方法名:类名应该是名次或名词短语;方法名应该是动词和动词短语,同时在方法名命名中,可以考虑将相应的构造器设置为private,强制使用这种命名手段。
9、别扮可爱:意思就是要严谨,不能太耍宝。
10、每个概念对应一个词:给每个抽象概念选一个词,并且一以贯之。函数名称应当独一无二,而且要保持一致,这样可以大大节省下浏览的时间,找到正确的方法。
11、别用双关语:避免将同一单词用于不同目的。
12、使用解决方案领域名称:只有程序员才会读你的代码。所以,尽管用那些计算机科学术语、算发名、模式名、数学术语等。
13、使用源自所涉问题领域的名称:如果不能用程序员熟悉的术语来给手头的工作命名,就采用从所涉问题领域而来的名称。优秀的程序员和设计师,其工作之一就是分离解决方案领域和问题领域的概念。与所涉问题领域更为贴近的代码,应当采用源自问题领域的名称。
14、添加有意义的语句:如果不能通过良好的命名的类等来给读者提供语境。那么给名称添加前缀就是最后一招了。例如firstName、lastName、street、houseNumber等,这样可以看出是构成一个地址。如果只有state变量的时候呢?可以添加前缀addrFirstName、addrLastName、addrState等,以此提供语境。语境的增强也让算法能够通过分解为更小的函数而变得更为干净利落。
15、不要添加没用的语境:只要短名称足够清楚,就要比长名称好。别给名称添加不必要的语境。
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值