浅析代码规范问题对软件编程的重要性
2014-04-29李勇
李勇
摘 要 随着信息技术行业的高速发展,软件行业也在夜以继日的以一种昂扬的姿态不断探索与前进。在过去的时间里,软件开发所用语言大多是Java和C++,而C#作为后来兴起的软件开发语言,同样具有较高的地位。本文旨在通过对规范代码这一问题进行探讨,了解其对于软件编程工作的地位以及重要性,以期于有效提升软件编程能力。
关键词 C#语言 语言规范 软件编程
中图分类号:TP31文献标识码:A
软件开发需要技术人员的经验和态度。当然,程序员的工作经验是要靠实际工作来进行积累的,那么对于刚刚参加工作的程序员们来说,一套完善的软件开发规范制度是必要的,即,一套完善的软件开发时的工作制度与代码使用规范可以对程序员的正常工作起到一定的约束作用。
1代码规范
(1)命名规范
变量、方法名、类名和借口名的命名都应该清楚明了,最好选用通用的名称,让旁人一眼便可看出,避免由于主观的认知而让他人产生对于名称的误解。而单字母命名往往会造成歧义,虽然命名简单但是不能够达到预期的效果。应该注意的是,在命名是一定要使用英文,注意使用Pascal的大小写规则与Camel规则。两种规则虽然有所不同,但是其根本目的仍是方便开发人员的理解,增强代码的可读性。
(2)代码注释
在代码编写的过程中,往往需要对代码进行注释,这样既增加代码的辨识度,又提高了代码的可用性。如:
If(1==1)
{statement;}
对于经验丰富的程序员可能不会有任何的理解影响,但是对于新晋的程序员往往会由于“1==1”这个条件啊产生较大的歧义,如果在if语句后加上注释
If(1==1)//always true
这样,这个if语句的含义便很明了了,即:每一次该语句的判断均为true,故每一次运算的结果都会传入下方进行体中。工作经验是需要一定是时间才能积累的,如果工作时间不够,没有针对相应环境的经验,则很容易造成与分歧。
(3)代码优化
对于一些循环语句,为了减少一些不必要的循环,当必要的循环逻辑已经完成之后,如果还未达到之前规定的循环次数,为了减少服务器的资源消耗,提高页面反应的速度,故此时需要跳出循环。
(4)代码分层
现在软件开发工作日益严峻,工作量不断加大,尤其是各种编程技术的发展在不断增速,技术多样化的今天,代码分层的重要性正在不断的展现出来。
2代码规范的重要性
(1)代码规范可以减少即时问题的发生
其实程序员的工作有时并不像想外人想的那样终日埋头在案前进行大量的运算。就像刚才提到的,复杂的运算过程和冗长的逻辑设计往往不是工作量最大的,工作量最大的是编写代码。但是简单不意味着不会出现问题,往往越简单的工作出现问题的频率就会越高。而原因在很大的程度上都可以归于没有一个规范的代码使用制度。没有规范的对输入输出参数的规范,没有规范的异常处理,没有规范的日志处理等等,不但导致了我们总是出现类似空指针这样低级的bug而且还很难找到引起bug的原因。
(2)规范代码可以方便代码的查错工作
代码编写完成后不意味着万事大吉,往往此时只是完成了编写的一个部分,而另一部分就是对源代码的审查工作。及时地复查可以避免错误地发生,也可以端正编程人员的态度,使其工作更加谨慎认真。而且,作为一个团队,可以在其他人编写完代码之后查出其中的错误,对于整个团队的其他成员也是一种学习和进步。但是,如果代码书写不规范,不但严重影响了审查工作的进行,加大了工作量与工作难度,有时甚至会造成没有办法审查的严重后果。由于不了解此代码编写是否成功,因此代码便会被弃用。由此,代码书写的规范可以让程序编写的审查工作更好开展,提高了效率和效果,同时也提高了整个团队的代码开发速度。
(3)规范代码可以提升团队的合作能力
作为团队型工作,如果不规范代码书写,则每个人写出的代码都会有不同的解读障碍。如果是多人同时在书写同一段代码,对于代码可用度的辨识上就会出现很大的分歧;如果是每一个人都有明确的分工,确定其负责的步骤,在整合的时候工作量也会由于每个人代码的差异而加大。很多时候,读不懂代码不仅仅是因为专业知识不够或者是代码有多么复杂难懂,只是因为别人的代码书写方式和自己的不尽相同。如果将代码书写进行规范,则提高了代码在团队中的可读性,每个人看到代码都不会产生疑问,自然会提高整个团队的工作效率。
(4)规范代码可以减少由于维护带来的开销
之前说到的问题如果不去解决,则会影响到所开发程序的质量,在开发过程中,前期的开发工作实际上只是对于程序的编写,而后期的调试才是整个过程中开销最大的一项。代码的质量不够,则需要多次进行检查,而且每一次检查都会需要相应的投入。在每个人的代码书写没有统一的时候,即使是一段没有问题的代码经过数次维护,最后也会成为了乱码,维护又该怎样进行?因此,只有规范代码的书写才能减少维护。
3总结
总之,在代码规范问题中,最重要的还是要树立良好的代码编写规范准则,在不断的实践工作中积累经验,并将其运用与平时的代码编写中。只有通过实践,才能不断的提高自身的技术水平,严惩不良的行为习惯,保证代码运行效率,让写出的代码真正有效运用到软件开发过程中。
参考文献
[1] 张纪生.小仪编写面试高质量代码[J].经营管理者,Manager Journal, 2012.07.