代码整洁之道-格式

Posted 2022-11-23 hujingnb

对于代码的格式，每个人都有不同的代码风格，这没什么。但是对于一个团队来说，最好能够统一代码风格，在同一个项目中，如果到处充斥着不同的代码风格，相比读起来并不是那么让人舒适，比如在什么地方放置括号，缩进几个字符，如何命名常量、变量和方法等，整个团队都应该遵循同一套规则，甚至可以将这些规则编写到IDE的代码格式中，利用IDE的提示功能来帮助。

刚才说的风格随不同，但是并不会影响读者阅读。但是有些代码风格让人难以阅读，而有些则会让读者心旷神怡。那么怎样的格式能够让人愉悦的阅读呢？简单的总结几条，可以看看是否会帮助阅读，若是，请这样做。

1. 在每个方法前加空行，起强调作用

2. 局部变量的生命尽量靠近其使用的位置

3. 类变量应在类的顶部声明

4. 若某个函数调用了另一个函数，应该将调用者放到被调用这的上面，这样有一个自然阅读的顺序

5. 执行相似操作的一组函数应该放在一起

6. 每行代码不应过长，至少不能超出屏幕阅读的宽度

7. 代码的缩进，不用解释，阅读缩进不规范的代码是在令人痛苦

8. 如果循环语句的循环体为空，也要确保空循环体的缩进，否则很容易将后一句看做循环体

9. 等等