这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天。

一：本堂课重点内容

这节课主要对什么是高质量编程给出了讲师自己的理解，其中，主要对如何编写简洁清晰地注释，在代码中什么是好的命名规范，如何设计更加清晰的控制流程，如何处理程序中出现的错误以保证程序的稳定性进行细致的讲解。

二：详细知识点介绍

2.1：什么是高质量的代码

每个人对高质量代码的定义不同，但是总的来说，在实际项目开发中的高质量代码，就是可靠，稳定，易读的代码。追求编写高质量的代码，才会有更加高效的团队效率。

2.2：注释

“好的代码有很多注释，不好的代码需要很多注释”，好的注释对于高质量代码是必须的。在我们写的代码中，如果是一些简单清晰的逻辑，那么往往不需要注释，但是如果是复杂的逻辑，那么注释是必须的，毕竟代码是写给人看的，而不是写给机器看的。具体的来说，我们需要在一些公共的方法函数上面使用注释来表明这个函数的作用是什么，或者一些重要的变量，我们也要标明变量的作用。

2.3：命名规范

在我们编写代码时，优良的命名可以让我们的代码更加易读，好的命名需要有见名知义的效果。但是同时我们的命名还要简洁，不要暴露已有的上下文信息，因为在调用的时候，这样会导致信息冗余。同时，应该注意缩略词应该全部大写。

2.4：控制流程

简洁的控制流程可以让我们的代码更加美观，举个例子，当控制语句中if和else代码块中都有return语句，我们最好就不要单独给这个if附加一个else代码块了。

三：课后个人总结

这些编码规范都是自己平时写代码中没有注意到的，但是实际工作中需要与团队协作，那么好的编码规范应该收到重视。