代码规范的意义 |
1、规范的代码促进团队合作
一个团队有统一的代码规范是团队协作最基本的准则。每个人代码风格迥异,想要读懂别人代码实在是一件痛苦的事情。而且团队中每个人有自己的分工,整合代码也是个不小的工程。从现在开始,规范我们的代码,提高我们代码的可读性,为了促进团队合作,为了方便他人方便自己。
2、规范的代码提高开发效率
代码规范可以使我们的开发效率大大提高,一些复杂的算法,bug不但可以减少,还可以迅速的调试bug,为了使调bug轻而易举,能够快速完成我们的开发工作,我们每写一句代码都要注重格式规范。
3、规范的代码降低维护成本
随着我们项目经验的累积,会越来越重视后期维护的成本。而开发过程中的代码质量直接影响着维护的成本。因此,我们不得不从开发时便小心翼翼。维护工作不仅仅是读懂原有代码,而是需要在原有代码基础上作出修改。我们可以先想像没有统一风格的情况下,A完成开发以后,B进行维护加一段代码,过一段时间C又加一段代码。。。。。。直到有一天维护人员看到那一大堆乱码,维护也就进行不下去了。因此,统一的风格有利于长期的维护。
4、有助于程序员自身成长
即使明白代码规范的好处,但是有的迫于项目压力,有的因为繁琐的规范作出很多额外的工作,更有的不重视维护的问题,而很难贯彻代码规范。那么,我们需要了解,规范开发最大的受益人其实是自己!每天垒乱码(或许你不觉得,但是大多时候在别人眼中确实就是乱码)并不能使你获得更多的进步,相反要达到高水平的程序员,养成良好的开发习惯是绝对必需的。不要沉迷表面的得失,看似无用的东西要经过慢慢的累积由量变达到质变的时候,你才能感受到其价值所在。
代码命名规范 |
- 名字应该能够标识事物的特性,并且与业务挂钩。
- 名字一律使用英文单词,而不能为拼音。
- 名字可以有两个或三个单词组成,但不应多于4个,控制在3至30个字母以内。
- 在名字中,多个单词用大写第一个字母(其它字母小写)来分隔。例如:IsSuperUser。
- 命名避免和以下关键字冲突
- 命名一般使用大/小驼峰进行命名
- 方法名、参数名统一使用驼峰命名法(Camel命名法),除首字母外,其他单词的首字母大写,其他字母小写,类名每个组合的单词都要大写;
代码格式规范 |
- 在必要的时候使用空格可以帮助我们清晰的看到代码逻辑
- 方法体等采用缩进风格
- 在必要时空行可以表达语义上的分割,注释使用范围等
注释规范 |
总结 |
良好的代码设计以及规范会给自己和他人带来很多益处,投入一点点就会带来很大回报。所以,从现在开始,每写一句代码都要严格遵守代码规范,这也是从一个程序员的角度讲,较专业化的表现,同时也会提高我们的核心竞争力。