高质量编程简介及编码规范 | 青训营笔记

71 阅读2分钟

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

一:本堂课的重点内容

image.png

二:详细知识点如下

1、高质量代码

编码规范、可读性、可维护性、重复度及可测试性(各种边界条件是否考虑完备,异常情况处理,稳定性保证,易读易维护)

2、注释:

公共符号始终要注释。不需要注释实现接口的方法。注释应该提供代码未表达的上下文信息。

image.png

image.png

3、代码格式

image.png

image.png

4、命名规范

1)变量

image.png

2)函数

image.png

3)包

image.png

5、控制流程

1)避免嵌套,保证正常流程清晰。
2)尽量保持正常代码路径为最小缩进

image.png

3)总结

image.png

6、错误和异常处理

1)简单错误

image.png

2)错误的Wrap和Unwrap

image.png

3)错误判定

image.png

4)panic

image.png

5)recover

image.png 如果需要更多的上下文信息,可以recover后在log中记录当前的调用栈。

6)对比

image.png image.png

四、课后个人总结

好的代码一定是整洁的,并且能够帮助阅读的人快速理解和定位。好的代码可以加快应用的开发迭代速度,不必花过多的时间来修复 bug 和完善代码。好的代码不但能够使得新的项目成员更容易加入项目,同时方便项目组成员快速做好 Back up。好的代码便于促进团队间交流合作提升开发效率。

由于信息的时间局限,我们始终仅能作出当时看起来不错的局部最优,但这大概率不是全局最优。我们需要开放心态,真正高质量的代码和架构是不断优化出来的。我们真正要坚持的是代码品味,保证每次代码/架构变更都比现在更好,那么在一定时间之后就可以使得代码/架构成为高质量的典范。

五、引用参考

blog.csdn.net/weixin_3863…