代码格式就像写作时的文章格式一样,好得格式排版(这个词不是很准确,但很能表达出来我的意思),会让阅读者更加容易理解代码的层次。
目前绝大多数IDE 都会自动格式化代码,善用这些功能。
1. 垂直代码的格式
1.1 代码的行数
大多数优秀代码的行数在200--500之间,参考(junit、tomcat、fitnesse、tam),数据作为参考,但绝对有价值。
1.2 善用空行
相关信息放在一起,通过空行与其他信息分开。不同的方法之间使用空行隔离开来,便于阅读。
1.3 合理的位置
本地变量应该在方法的顶部;
实体变量应该放在类的顶部;
相关联系的代码应该尽量放在一起;
方法调用者应放在被调用者之上;
2. 横向代码的格式
2.1 代码的宽度
同样是数据参考,80-120 一行代码最多字符的上限。
2.2 横向代码之间的空格
一般会在运算符左右加入空格,以便于阅读。
3. 尊重团队格式习惯
无论你的代码格式习惯是多么的好,但千万不要与你的团队与众不同,毕竟你的团队才最可能是你的读者。