| layout | title | tags |
|---|---|---|
post |
写出清晰代码的六条简单原则 |
编程规范 |
大家好。
写代码其实有很多简单的规则，但是在日常的团队工作中，发现很多其实并没有遵循的很好，所以有必要经常拿出来说说。最近看到一个博客文章 “AVOID SPAGHETTI CODE WITH SCOPE MINIMIZATION”，介绍了写出清晰代码的六条简单原则，真的是很简单的六条原则，主要思路就是减少代码的作用域。
今天就在这里简单介绍一下这些原则，如果大家感兴趣可以去看博主的原文。
1、绝不使用全局变量
使用全局变量会使得代码更难维护和可读，可测性也会降低很多。大量使用全局变量也会造成一些不必要的副作用，而这些往往造成问题很难识别和修复。
2、定义单一用途的变量
变量的用途越多，意味着对应变量在代码中出现的频率也会变多，而出现问题的隐患也会增多，最终也会造成问题难以识别和修复。
3、在变量使用的地方定义变量
变量离使用的地方离得越远，对代码的阅读会更难，同时后续的代码调整也会增加复杂度。
4、保持代码块的简单（尽量小）
简单也可以理解为代码的作用单一，越单一的代码越容易保持上下文代码的简洁。
5、使用变量时靠近其变量定义处
这个原则与原则 3 呼应。
6、不要使用超过 2 层的嵌套代码
当代码的嵌套层级超过 2 层的时候，可以将子代码块抽象到单独的函数，这样会让代码更容易阅读和维护。
更多详情请查看如下链接：
https://massimo-nazaria.github.io/blog/2022/02/10/avoid-spaghetti-code-with-scope-minimization.html
关注我们，一起探索有意思的开源项目。