`
kdboy
  • 浏览: 759126 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

代码规范的重要性

阅读更多
代码规范比比皆是,但是很少有公司做好代码规范的。忍不住想谈谈代码规范的重要性,希望所有人都能够重视起来。而且,我相信,如果我们代码规范能够做好的话,且不说开发水平提高多少,至少我们也会有很多出色开源项目。

一、规范的代码可以促进团队合作
一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码必定会风格迥异。且不说会存在多个人同时开发同一模块的情况,即使是分工十分明晰的,等到要整合代码的时候也有够头疼的了。大多数情况下,并非程序中有复杂的算法或是复杂的逻辑,而是去读别人的代码实在是一件痛苦的事情。统一的风格使得代码可读性大大提高了,人们看到任何一段代码都会觉得异常熟悉。显然的,规范的代码在团队的合作开发中是非常有益而且必要的。

二、规范的代码可以减少bug处理
很多IT人士将程序员比做民工,这也的确非常的形象。就像刚才提到的,复杂的算法或逻辑只占项目中很小的比例,大多仅仅是垒代码的工作。可是越是简单,测试的bug反而是越多,而且是无穷无尽的bug。这里很大的程度上是由于代码不规范所致。
没有规范的对输入输出参数的规范,没有规范的异常处理,没有规范的日志处理等等,不但导致了我们总是出现类似空指针这样低级的bug而且还很难找到引起bug的原因。相反,在规范的开发中,bug不但可以有效减少,查找bug也变得轻而易举。
规范不是对开发的制约,而确实是有助于提高开发效率的。

三、规范的代码可以降低维护成本
随着我们项目经验的累积,会越来越重视后期维护的成本。而开发过程中的代码质量直接影响着维护的成本。因此,我们不得不从开发时便小心翼翼。
在第一点中曾提到,规范的代码大大提高了程序的可读性,几乎所有的程序员都曾做过维护的工作,不用多说,可读性高的代码维护成本必然会大大降低。
但是,维护工作不仅仅是读懂原有代码,而是需要在原有代码基础上作出修改。我们可以先想像没有统一风格的情况下,A完成开发以后,B进行维护加一段代码,过一段时间C又加一段代码。。。。。。直到有一天X看到那一大堆乱码想死的心都有了,维护也就进行不下去了。因此,统一的风格有利于长期的维护。
另外,好的代码规范会对方法的度量、类的度量以及程序耦合性作出约束。这样不会出现需要修改一个上千行的方法或者去扩展一个没有接口的类的情况。规范的代码对程序的扩展性提高,无疑也是对维护人员的一个奖励。

四、规范的代码有助于代码审查
我个人是比较赞同进行代码审查的,这样可以及时纠正一些错误,而且可以对开发人员的代码规范作出监督。团队的代码审查同时也是一个很好的学习机会,对成员的进步也是很有益的。但是,开发随意,加重的代码审查的工作量及难度,并且使得代码审查工作没有根据,浪费了大量的时间却收效甚微。
代码规范不仅使得开发统一,减少审查拿督,而且让代码审查有据可查,大大提高了审查效率和效果,同时代码审查也有助于代码规范的实施。一举多得,何乐而不为呢。

五、养成代码规范的习惯,有助于程序员自身的成长
即使明白代码规范的好处,但是有的迫于项目压力,有的因为繁琐的规范作出很多额外的工作,更有的不重视维护的问题,而很难贯彻代码规范。
那么,我们需要了解,规范开发最大的受益人其实是自己!
你有没有花费很多的时候查找自己的代码呢?尤其是出现bug的时候需要逐行的debug?自己写的代码乱了头绪的确实也见了不少。我们应该做的就是规范开发,减少自己出现的错误。很多时候项目的压力一部分也是由于前期开发中遗留的众多的问题。
还有的人觉得自己可以完成高难度的算法,就认为自己能力很强,不把规范放在眼里。很多人确实是这样,追求个性,大概让别人看他的代码一头雾水更觉得得意。殊不知复杂的算法确实可以体现你个人的逻辑能力,但是绝不代表你的开发水平。我们知道一些开源项目,一些大师级人物写得程序都是极其规范的。并非规范了就代表高水平,实际上是规范的代码更有利于帮助你理解开发语言理解模式理解架构,能够帮助你快速提升开发水平。不明白这点,即使你写的再高明的算法,没准哪天也被当作乱码别处理掉。
记住!每天垒乱码(或许你不觉得,但是大多时候在别人眼中确实就是乱码)并不能使你获得更多的进步,相反要达到高水平的程序员,养成良好的开发习惯是绝对必需的。
不要沉迷表面的得失,看似无用的东西要经过慢慢的累积由量变达到质变的时候,你才能感受到其价值所在。

最后提醒一句,制定一个符合自己公司情况的开发规范是很简单的,重要的是我们能够认识到规范的重要性,并坚持规范的开发习惯。
24
1
分享到:
评论
6 楼 lucky16 2009-06-14  
规范是人定的?还是?

5 楼 kdboy 2009-06-14  
kangzhengfei 写道

楼主能不能来点具体的,什么样的才是规范!

Google
4 楼 kangzhengfei 2009-06-14  
楼主能不能来点具体的,什么样的才是规范!
3 楼 flyfan 2009-06-13  
2年了,从未遇到过比自己编码更规范化的程序员,代码中充满各种的警告提示
2 楼 kdboy 2009-06-13  
liangcoder 写道

这需要一批职业化程度很高的程序员~

是不是有点本末倒置了?
职业化程度很高的程序员必然有着规范的开发习惯。
但是代码规范的前提不应该取决于这样的程序员,而相反要到达如此水平的前提应该是做到规范的代码开发。
1 楼 liangcoder 2009-06-13  
这需要一批职业化程度很高的程序员~

相关推荐

    代码规范重要性

    代码规范重要性

    java代码规范

    忍不住想谈谈代码规范的重要性,希望所有人都能够重视起来。而且,我相信,如果我们代码规范能够做好的话,且不说开发水平提高多少,至少我们也会有很多出色开源项目。 一、规范的代码可以促进团队合作 一个项目...

    项目开发代码规范和命名规范

    编码规范第二、可以提高代码质量,谁编程都不是一次性完成的,是需要不断的测试与调试,以各种状态来修改自己的代码,而将代码规范化,就能对程序本身有更加清晰的结构思路,从而减少调试而成为快捷高效的代码。...

    Delphi7代码规范

    Delphi7代码规范,本文档详述了在Delphi 7开发者指南下进行编程的代码编写标准。在通常情况下,本文档遵循“取消”式格式的指引方针,该方针由Borland国际通过一些例外来使用。在Delphi 7开发者指南中包含本文档的...

    谈谈变量命名规范的重要性

    下面小编就为大家带来一篇谈谈变量命名规范的重要性。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧

    基于java模式下的编程要诀 代码规范 面向对象

    该电子档是java编程模式中的关于代码编写与实现的总结,其中很好的体现了面向对象编程的重要性!很适合初学者知道大概轮廓!

    JavaSE安装包(3) 包括scala-SDK,向日葵(远程工具),阿里Java代码规范等

    以下是对Scala-SDK、向日葵(远程工具)和...阿里Java代码规范旨在提高代码的可读性、可维护性和稳定性,使得团队协作和代码维护更加高效和一致。 这些工具和规范在各自领域和场景中扮演着重要的角色。Scala-SDK提供了

    ActionScript代码开发规范

    今天我才意识到代码规范的重要性!!!真的很有帮助,编程是一种艺术!

    基本的代码规范

    排版可以使程序结构清晰,观者心怡,对于增强程序的可读性和可维护性起着至关重要的作用,因此程序员应该注意排版,这也会给以后的工作(修改、维护程序的工作)带来极大的方便.

    C# 代码开发规范

    为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。 编码规范对于程序员而言尤为重要,有以下几个原因: 1) 一个软件的生命周期中,80%的花费在于维护。 2) 几乎没有任何一个软件,...

    Java代码命名规范详解含详细示例

    在Java编程中,代码命名规范的重要性不容忽视。它不仅影响着代码的可读性和可维护性,还直接关系到项目的开发效率和团队协作的顺畅性。一个遵循良好命名规范的代码库,可以使开发者更快速地理解代码意图、减少错误、...

    C,c++输入代码规范

    使代码易于管理的方法之一是增强代码一致性,让别人可以读懂你的代码是很重要的,保持统一编程风格意味着可以轻松根据“模式匹配”规则推断各种符号的含义。

    Verilog编码规范.docx

    使代码易于管理的方法之一是增强代码的一致性,让别人读懂自己的代码是非常重要的事情。因此,保持自己的代码符合统一的规范是一个编码者的基本素质。如果自己的编码风格与本文档的规定实在不同,无法忍受,请与维护...

    好代码是管出来的——C#的代码规范

    文章开始提到过代码是给人看的,代码规范的目的在于创建一个统一的规范来保持代码的整洁,这样有利于提高代码的可维护性,但除此之外还可以将一些代码的最佳实践也作为规范的一部分,这样还可以提高代码的性能和安全...

    华为 C语言编程规范 2011版(带书签).pdf

    在公司已有编码规范的指导下,审慎地编排代码以使代码尽可能清晰,是一项非常重要的技能。 如果重构/ / 修改其他风格的代码时,比较明智的做法是根据 现有 代码 的 现有风格继续编写代码,或者使用格式转换工具进行...

    Google的C++编码规范 中文.PDF

    使代码易亍管理的方法乊一是增强代码一致性,让别人可以诺懂你的代码是徆重要的,保持统一编程风格 意味着可以轱松根据“模式匹配”觃则推断各种符号的吨义。创建通用的、必需的习惯用诧和模式可以使 代码更加容易理解...

    Google 开源项目风格指南.pdf(C++,2017版)

    Google 开源项目风格指南中文版pdf 里面规定了google的C++开源项目的代码规范,是提高代码易读性和健壮性的重要参考资料。

    .NET软件开发编码规范

    应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因: 1、好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护; 2、...

    华为FPGA设计规范.doc

    最近编写了几个比较大的程序,深切体会到代码风格的重要性。好好看看吧,不学习的话要被大牛们BS的。 verilog , 风格

    Java编程规范

    大家都很清楚编程规范的重要性,一个好的程序员,从他的代码中,一眼就可以判断出来。编程规范之所以重要的原因如下:代码完成之后,基本上一直处于维护阶段,并且维护工作经常是不断更替人员的;代码格式的一致性,...

Global site tag (gtag.js) - Google Analytics