今天是我参加青训营的第四天
大重点!注释!!
注释应该做的
解释代码的作用
这种注释适合说明公共符号,对外提供的函数需要注释来描述他的功能和用途,还要小心不要对显而易见的功能进行解释,比如说通过名称就可以很容易知道作用的函数。
解释代码如何做的
这里是比如说代码很复杂,而且它的逻辑并不明显所以我们需要通过注释来说明它的实现过程,这里要小心有的时候注释的表述和代码不一定一致,因为有可能他已经经历了几代程序员的手了,到你这里有可能前面的程序员没有更新注释。还是看代码吧,代码就是最好的注释。
解释代码实现的原因
这个就是相当于给一个说明,中间孤零零的一个函数,谁能看懂它是什么作用啊?你要告诉其他成员它是用来实现什么的,或者它的上面是什么,下面又是什么,这样可以帮助别人更好的理解。
解释代码什么情况下会出错
这里是需要提醒使用者一些潜在的限制条件或者无法处理的情况他有可能存在性能隐患,输入有可能有限制条件,让使用者无需了解实现细节
公共的符号始终都要注释∶包中的常量,变量,函数以及结构都需要添加注释,还有一些不明显的公共功能,以及库中的任何函数都必须进行注释
命名规范
原则∶
简略胜于冗长
缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写
在命名变量时,变量位于其被使用的地方越远,则需要携带更多的上下文信息,使得他在不同地方可以轻易辨认出其含义
给函数命名的时候,函数名不携带包名的上下文信息,因为包名和函数总是成对出现的且函数名应尽量简短
对于包命名的时候,包名只由小写字母组成,不含大写字母和下划线等字符,包名需要简短,并且包含一定的上下文信息,不能与标准库同名
总之,核心目标是降低阅读理解代码的成本
在控制流程时,我们应该避免嵌套,尽量保持正常代码为最小缩进,避免复杂的嵌套分支,让正常流程代码沿着屏幕向下移动,提升代码的可读性