这是我参与「第五届青训营 」伴学笔记创作活动的第11天
项目实践
这节课进行了对于高质量编程的定义和原则，内容中分享了代码格式、注释、命名规范、控制流程、错误和异常处理五方面的常见编码规范。这节课的内容有助于编写出更加简洁清晰的代码。
(1). 高质量编程
在编写代码前，要清楚什么是一个优质的代码。首先给出高质量编程中“高质量”的定义：即为对编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。
需要从各种边界条件是否考虑完备、异常情况的处理是否得当，是否能够保证稳定性、是否易读易维护几个方面来评判。
对于编程原则，实际应用场景是不断变化且难以固定化的，各种语言的特性和语法不尽相同，这种时候就需要一种规范来统一规划，高质量编程遵循的原则是相通的，这一点不容忽视。
高质量编程具有简单性、可读性、生产力的特点。首先是简单性，要注意消除多余的复杂内容，用简单而清晰的逻辑编写代码、不理解的代码无法修复改进。然后是可读性，因为代码是给人看的，而不是为了机器，对于继任位置的开发者和维护人员来说，可维护、可读性高的代码是非常重要的，要保证其他人能看懂。生产力是指整个开发团队的整体工作效率要有保证，不能拖沓和不配合。
从注释上来说，公共符号始终要加上注释。Golang包中声明的每个公共符号，变量、常量、函数和结构都需要添加注释以提高可读性和可维护性。对于任何既不明显也不简短的公共功能需要予以注释，并且无论长度和复杂程度如何，对库中任何函数都要进行注释。
/*
函数功能
参数1：Writer用于写文件
参数2：要写入的内容，为byte数组
返回值：error，对于写入错误，进行报错
*/
func WriteBuf(r Writer, [] byte)(error)
总结来说，是代码格式、注释、命名规范、控制流程、错误和异常处理几个方面促成了高质量代码。
