`
kdboy
  • 浏览: 761419 次
  • 性别: 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作为一种广泛使用的编程语言,同样强调代码规范。本篇文章将详细...

    代码规范代码规范代码规范代码规范

    代码规范是编程实践中非常重要的一环,它旨在提高代码的可读性、可维护性和团队协作效率。本规范主要涵盖了以下几个方面: 1. **命名规则**: - 所有命名应使用标准英文单词或缩写,避免使用拼音或拼音缩写,除非...

    代码规范.pdf

    在描述部分,强调了代码规范的重要性,提出了几个关键点: - 代码需要清晰地传达其目的和结构。 - 软件的生命周期中,大约有80%的成本花在了维护上。 - 软件很可能不会由原作者进行维护。 - 代码是产品的一部分,...

    iOS软件代码规范

    在 iOS 软件代码规范中, 可靠性主要包括正确性、健壮性、可维护性、可移植性等方面。 断言与错误处理 断言与错误处理是软件开发中的基本要求。在 iOS 软件代码规范中,断言与错误处理主要用于检测和处理错误,...

    浅析框架与代码规范.pdf

    #### 代码规范的重要性及实践方法 在现代软件开发过程中,代码规范扮演着至关重要的角色。它不仅有助于提高代码的可读性和可维护性,还能促进团队之间的协作效率,减少潜在的错误和缺陷。本文档“浅析框架与代码...

    单片机程序编写代码规范工具

    1. **代码规范的重要性**: - 提高代码可读性:规范的代码结构和命名规则使得其他人更容易理解代码逻辑,便于团队协作。 - 降低错误率:遵循统一的编程规范可以减少因拼写错误或不一致的命名引发的bug。 - 提升...

    代码规范代码规范.txt

    本篇将基于《代码规范代码规范.txt》的内容,详细介绍其中提及的各项规范要点及其重要性。 #### 二、代码规范目的 《Lifeix代码规范》的主要目标是确保组织内部能够以标准化、规范化的方式来设计和编写代码。通过...

    阿里巴巴代码规范-泰山版.pdf

    首先,手册以Java开发者为对象,强调了编程规范的重要性。随着现代软件行业的发展,开发者被要求具备更高的综合素养,除了掌握编程知识外,还需要考虑到代码的维护性、可读性以及安全性等方面。例如,错误码设计的...

    Java代码规范.pdf

    Java代码规范文档中涉及的知识点涵盖了Java编程实践中的命名风格和代码组织方式,旨在为Java开发人员提供一份行业内部开发的准则,确保代码的可读性、一致性和维护性。以下是从提供的文档内容中提炼出的相关知识点:...

    华为代码规范代码模板

    在软件开发过程中,代码规范和模板的使用是至关重要的,它们能够提高代码的可读性、可维护性和团队协作效率。华为作为全球领先的ICT解决方案提供商,对于代码质量有着极高的要求,因此制定了一套详尽的代码规范。这...

    google C++ _华为_中兴编程规范打包下载

    随着业内对代码规范重要性的不断认可与强调,越来越多的公司开始制定并公开自己的编程规范,以此来指导和统一开发团队的行为。本资源集合了来自Google、华为和中兴这三家行业巨头的C++编程规范,为开发者提供了一套...

    百度前端代码规范.pdf

    百度前端代码规范是一份旨在统一前端开发标准的文档,由百度前端团队或社区成员共同维护和分享。该规范涵盖的内容非常全面,包括但不限于Javascript编码规范、HTML编码规范、CSS编码规范、Less编码规范、E-JSON数据...

    JAVA代码规范 JAVA规范 代码规范

    Java代码规范是编程实践中至关重要的一个方面,它旨在确保代码的质量、可读性和维护性。以下是一些核心的Java代码规范要点: 1. **命名规范**: - 类名使用大驼峰命名法,所有单词首字母大写,例如`ClassName`。 ...

    前端代码规范.rar

    3. **注释**:良好的注释是代码规范的重要组成部分,它要求开发者为复杂的逻辑、函数或组件添加注释,解释它们的作用和用法。注释应简洁明了,避免过于冗余。 4. **代码结构**:规范可能包含关于模块化、组件化编程...

    代码规范.zip

    在编程世界中,代码规范是确保团队协作效率和软件质量的重要组成部分。对于Python这样的语言,遵循良好的代码规范可以使代码更具可读性、可维护性和一致性。"代码规范.zip"这个压缩包包含了多个版本的Python开发代码...

    代码规范.rar 阿里巴巴java代码规范

    在软件开发领域,代码规范起着至关重要的作用,它不仅可以提高代码的可读性和可维护性,还能确保团队之间的代码风格一致性,从而提升开发效率。阿里巴巴作为国内知名的互联网企业,有着一套完善的Java代码规范,旨在...

    C++代码规范培训心得

    最近参加了一次关于C++代码规范的培训,我的心得体会颇多,以下我将结合培训内容和个人认识,从代码习惯的重要性、命名规范、代码排版布局、效率优化等方面,详细阐述我在C++代码规范培训中的所学所思。 首先,培训...

    C++代码规范检查工具

    **代码规范的重要性** 1. **可读性**:遵循统一的代码规范可以提高代码的可读性,让其他开发者更容易理解你的代码。 2. **可维护性**:规范的代码降低了出错的概率,使得后期的维护和调试工作更为轻松。 3. **...

    C/C++代码规范

    C/C++代码规范是指在编写C或C++程序时所遵循的一系列编程规则和约定,其目的是为了提高代码的可读性、可维护性,以及便于团队协作。一个良好的代码规范可以减少代码中的错误,提升代码质量,同时还能帮助开发者更快...

Global site tag (gtag.js) - Google Analytics