关于如何给变量函数命名

一位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就行 ,

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

时间: 2024-11-03 21:19:34

关于如何给变量函数命名的相关文章

C++学习笔记5:如何给变量及函数命名?

1.遵循C++规定的变量及函数命名方法: 2.原则:简单,易于理解: 以下是一些例子,可以作为参考: //bad examples: int ccount;//Nobody knows what a ccount is. int i;//Generally bad unless use is trivial or temporary, such as loop variables. int _count;//don't start variable names with underscore.

Swift常量和变量以及命名规范

我们在上一章中介绍了如何使用Swift编写一个HelloWorld小程序,其中就用到了变量.常量和变量是构成表达式的重要组成部分.常量在声明和初始化变量时,在标识符的前面加上关键字let,就可以把该变量指定为一个常量.顾名思义,常量是其值在使用过程中不会发生变化的量,实例代码如下:let_Hello = "Hello"_Hello标识符就是常量,只能在初始化的时候被赋值,如果我们再次给_Hello赋值,代码如下:_Hello = "Hello, World"则程序会

开篇、注释、基本数据类型、常量变量、命名

command +"<stdio.h>"内容进入头文件内容 几行一起注释 选中command+/ 新建工程(选中Xcode): command+shift+N // 注释,在编译时忽略 作用: 1> 被注释的代码不会参与编译 l   注释是写给人看的,不是给计算机看的.计算机怎么可能看得我们写的中文嘛.因此,当编译程序的时候,并不会将注释编译到.o目标文件中 l   从.o文件的大小可以间接看出注释后的代码并没有被编译 2>  检查代码的作用 3 > 排除

C++函数命名规则

转自:http://blog.csdn.net/rocksword/article/details/10104533 1.严格采用阶梯层次组织程序代码:        各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行.要求相匹配的大括号在同一列,对继行则要求再缩进4格.例如:        2.提示信息字符串的位置        在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中.        3.对变量

scala快速学习笔记(一):变量函数,操作符,基本类型

为了用spark,先学下scala. 参考教程:http://meetfp.com/zh/scala-basic 在线编译:http://meetfp.com/tryout 其它资料:http://scalachina.com/node/16 http://blog.csdn.net/mapdigit/article/details/21878083 特点: Scala是一种纯面向对象的语言,一切都是对象:将原始类型和类统一起来,同时也将函数和操作符统一起来. Scala又是函数式语言,这体现在

php变量规范命名用了记得消除,保证唯一性

PHP中的命名规则 类的命名  在为类(class )命名前首先要知道它是什么.如果通过类名的提供的线索,还是想不起这个类是什么的话,那么就说明设计存在问题. 超过三个词组成的混合名是容易造成系统各个实体间的混淆,尝试使用(CRC Se- ssion card)看看该命名所对应的实体是否有着那么多的功用.  对于派生类的命名应该避免带其父类名的诱惑,一个类的名字只与它自身有关,和它的父类叫什么无关. 使用大写字母作为词的分隔,其他的字母均使用小写,名字的首字母使用大写 .不要使用下划线('_')

变量的命名

目标 标识符和关键字 变量的命名规则 0.1 标识符和关键字 1.1 标识符 标示符就是程序员定义的 变量名.函数名 名字 需要有 见名知义 的效果,见下图: 标示符可以由 字母.下划线 和 数字 组成 不能以数字开头 不能与关键字重名 思考:下面的标示符哪些是正确的,哪些不正确为什么? fromNo12 from#12 my_Boolean my-Boolean Obj2 2ndObj myInt My_tExt _test test!32 haha(da)tt jack_rose jack&

【Python基础 04】变量的命名和关键字

目标 标识符和关键字 变量的命名规则 0.1 标识符和关键字 1.1 标识符 标示符就是程序员定义的 变量名.函数名 名字 需要有 见名知义 的效果 标示符可以由 字母.下划线 和 数字 组成 不能以数字开头 不能与关键字重名 思考:下面的标示符哪些是正确的,哪些不正确为什么? fromNo12 from#12 my_Boolean my-Boolean Obj2 2ndObj myInt My_tExt _test test!32 haha(da)tt jack_rose jack&rose

Java中变量名命名的一些规定和规范

一.变量名命名的一些规定:1.必须以字母.下划线.或者美元符$开头:①以美元符$ 开头命名的变量虽然能够编译通过但是不建议使用: ②中文也可以作为命名开头且编译也能通过,但是不建议使用.2.除开头外后面的部分可以有字母.下划线.美元符$以及数字组成:3.虽然变量名不限制长度,但能表达清楚命名的含义即可:4.变量名不可以和java的关键字冲突:下面列出具体的关键字:①用于定义访问权限修饰符的关键字: private.protected.public ②用于定义类.函数.变量修饰符的关键字:abst