这是我参与「第五届青训营 」笔记创作活动的第3天 课程讲解内容: 1.高质量编程应该达到的:编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的 高质量的编程需要注意以下原则：简单性、可读性、生产力 2.高质量编程遵循的原则： 简单性 消除“多余的复杂性”，以简单清晰的逻辑编写代码，不理解的代码无法修复改进 可读性 代码是写给人看的，而不是机器，编写可维护代码的第一步是确保代码可读 生产力 团队整体工作效率非常重要 3.编码规范:代码格式，注释，命名规范，控制流程，错误和异常处理 4.注释:解释代码的作用，适合注释公共符号，解释代码如何做的，适合注释实现过程，解释代码实现的原因，适合解释代码的外部因素，提供额外上下文，解释代码什么情况会出错，适合解释代码的限制条件，公共符号始终要注释 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释 任何既不明显也不简短的公共功能必须予以注释 无论长度或复杂程度如何，对库中的任何函数都必须进行注释 不需要注释实现接口的方法 5.命名规范 变量 简洁胜于冗长 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写 例如：使用ServeHTTP而不是ServeHttp 使用XMLHTTPRequest或者xmlHTTPRequest 变量距离其被使用的地方越远，则需要携带越多的上下文信息 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义 函数 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的 函数名尽量简短 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息 package 只由小写字母组成，不包含大写字母和下划线等字符 简短并包含一定的上下文信息，例如：schema、task等 不要与标准库同名，例如不要使用sync或者strings 以下规则尽量满足，以标准库包名为例： 不使用常用变量名作为包名，例如使用bufio而不是buf 使用单数而不是复数，例如使用encoding而不是encodings 谨慎地使用缩写，例如使用fmt在不破坏上下文的情况下比format更加简短
