关于如何给变量函数命名

Posted 2020-10-04 红茶知道

一位google创作语言的工程师讲的非常好,详见 https://mp.weixin.qq.com/s/xRB5fy4KkZN9ziJUrpG8PQ 我会在下面总结一下

变量函数命名是基本功,不要忽略这些细节,在大公司里写代码可不是能实现基本功能就行了.

 

回到正题,总结:

1,变量的命名不要带上其数据类型中就已经说明的信息 如List<String> strings 就很好,不要写成List<String> stringList

2,函数的命名不要带上其参数列表中已经说明的信息, 如sortEventsUsingComparator(List<Event> events,Comparator<Event> comparator)要改成

   sort(List<Event> events, Comparator<Event> comparator)

3,变量或函数命名时不要带上删除后也不会引起歧义的单词(即多余的单词),如finalBattleMostDangerousBossMonster 写成boss也不会引起歧义,那么就写成boss就行了,

   事实上一个项目刚开始时变量函数命名先保证当时不引起歧义就行,如果随着项目的深入会引起歧义时再重构就好了,如果一开始就写的很复杂,那后面一般也不会去改了.

4,变量或函数命名时不要带上可以从上下文中获取到的信息 如在一个Student类中 不要写 int studentId 直接写 int id就行 ,

    实际上, 一个命名嵌套的层次越多, 它就有更多的相关的上下文，也就更简短。