代码规范及代码复审

1.对代码规范的讨论

编写一个程序是否需要代码规范?本人以为,规范当然得有,但也必须合理。

为什么我们需要代码规范?代码规范就是规定代码中某些格式必须遵守一定条件,比如缩进、变量命名、注释等。当制定了合理的规范后,不仅代码本身会显得美观,而且每个人都很容易读懂,代码的可维护性也大大增强。举个例子,甲程序里使用的变量名有input_msg,output_msg,decipher,每个符号之间均加了空格,而乙程序里则是随意地使用a,b,c等无意义的字母作为变量名,而且多个函数里重复使用相同名称的局部变量。这样,一旦程序出现bug需要调试,甲程序就会比乙程序更快地找到出错的位置。如此看来,代码规范是必不可少的。下面我们来看一看人们对代码规范的误解。

有人认为,“规范”是官僚制度的产物,只会降低编程效率、浪费时间。这种看法,我不敢苟同。如果编程的规范代表了官僚主义,那么还有什么规范不是官僚主义呢?没有规矩不成方圆,如果没有编程规范,那么每个人编写程序都是随心所欲,代码乱七八糟,就像物品胡乱堆放的仓库一样,想要读懂会很困难。这种一味把规范视为束缚的观点,很显然是不可取的。

还有人认为,我有自己的规范和原则,我没必要遵守别人强加给我的规范和原则。其实拥有自己的规范和原则并没有错,否则等同于没有规则。但是这种观点也过于个人主义,别人要你遵守某些规范和原则,你就以“这和我的原则冲突”而强烈排斥。然而,编写大程序时,光靠个人的努力永远不够,而需要团队的紧密合作。你非要完全按照自己的想法走,不顾别人的建议或是劝阻,那么团队的力量就会无法最大发挥出来。

又有人发话了,好吧,我承认代码是得有规范,但我也讨厌千篇一律,因此代码规范中应当允许很多例外。这种观点,是没有弄清楚代码规范本身的目的而产生的。代码规范并不是一刀切地规定每个人写的代码都必须是同一种风格,而只是在代码的关键部分寻求一些统一。想一想,国家的法律会要求每位国民都按照同一种方式生活吗?法律只是规定了你应当做什么,不应当做什么。代码规范也是一样,只是它不像法律具有强制性,而更像是一种引导,引导你如何写出美观、易读的代码。从这一点上看,合理的代码规范,是不会产生什么”例外“的。

但是,有的人自以为”我最会制定规范,我制定的规范最合理,所以你们都要听我的“,无异于把自己的观点强加于他人身上,违背了己所不欲勿施于人的道理。一份合理的规范应当是整个团队经过认真研讨后得出,并约定大家都要遵守的,既能让每个人都能接受,又具有一定的引导性。个人要求集体完全跟着自己走,就是把自己当成了官僚皇帝,就是不尊重队友的感情。你不尊重队友,队友凭什么来尊重你?

综上所述,我们需要一种合理的代码规范。一个好的程序中,应当处处体现这些代码规范。

2.代码审查实例

最近我对我的一位同学的代码进行了复审,其结果如下:

当输入正确的命令后,该程序可以正确地实现题目的生成与计算,可以正确评测对现有题目的作答,说明该程序实现了基本的功能。

该程序使用C#编写,采用面向对象的编程思想,程序不同的功能模块放入不同的源程序中,可以有效减少单个源文件的代码量,编写代码时按照规范进行缩进及添加空格,显得简洁美观。各变量、方法使用意义明确、简单的单词,程序的每一行代码不长,总体可读性较好。该程序没有重复、多余的代码,没有不必要的全局变量。

当输入错误的命令后,该程序能及时报出Exception并输出。经多次测试,未发现越界等低级错误。

该程序在必要的位置加上了注释,加强了程序的可读性。

如果该程序能配上一份详细、准确的说明文档,说明该程序的具体功能、操作细节等,就会更易使用和维护。

时间: 2024-10-17 15:29:09

代码规范及代码复审的相关文章

代码规范、代码复审、PSP

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

作业三: 代码规范、代码复审、PSP

(1) 是否需要有代码规范         1.这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西.(反对) 答:首先编码规范 包括了编码风格和其它规范 一个团队遵守一些规范有很多的好处! (1). 遵守编码风格使代码更容易维护 (2). 编码风格使形成代码集体所有制(集体所有制的作用很大,它能有效的增大巴士因子——一个项目能承受多少个程序员被车撞了而不影响项目的正常进行) (3). 编码风格能消除那些长久的纷争(你不需要喜欢这种编码风格.如果你不喜欢里面的某条规

软件工程第二周作业:代码规范和代码复审

0x01 :代码规划的要求 Q:这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西.(反驳) 首先,我们需要明确编码规范的定义,编码规范同时包括了编码风格和其它规范(代码设计上的规范,如设计模式.程序设计.模块之间的逻辑关联等). 编码风格,牵扯到“缩进.空格使用.注释.命名习惯”等多方面的因素,是依致特定编程语言制定的软件工程开发的“约定”,而相同的编码风格,可以使得软件开发过程中轻松浏览任意一段代码,充分保证不同的开发人员能够依据统一的编码格式轻松理解代码的逻

作业三: 代码规范,代码复审

是否需要有代码规范 1.反驳.代码规范是有实际纪意义的,斌不是形式主义的浪费时间. 2.反驳.编码风格不是代码规范. 3.反驳.代码规范就是要求格式一样的,不应该有例外. 4.反驳.一个人的规范不是规范.一个团队内部的规范也不是代码规范,所有人都遵守的才是代码规范, 总结:代码规范对团队合作很重要.一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码度是不同风格的,即使是分工十分明晰的,等到要整合代码的时候就会很麻烦.别人看你的代码需要很长时间,这样很没有效率.这样去读别人

Week2 关于代码规范与代码复审

1.代码规范 我觉得代码规范是有必要的,而对于以下的四个观点我要提出自己的反驳: 这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西 首先应该明白,什么是“编码规范”?它不仅仅包含了代码格式,还包括了编码风格和其他规范,通常涉及:缩进.空格使用.Tab使用.注释.命名习惯.代码行长度和语言特点风格,例如是否使用可有可无的分号……首先是在团队合作过程中,能够最好得综合每个人的编码习惯,从而使大家能够很轻松得互相阅读对方的代码从而促进团队中的沟通与交流.不是浪费时间.

web前端代码规范 - HTML代码规范

Bootstrap HTML编码规范 本文转载自w3cschool. 由于bootstrap得到了世界的认可,因此,此规范用于规范html代码有一定的说服力. 交流qq群:164858883.欢迎各位程序猿共享说得,共同进步,共同推进互联网的发展. 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 嵌套元素应当缩进一次(即两个空格). 对于属性的定义,确保全部使用双引号,绝不要使用单引号. 不要在自闭合(self-closing)元素的尾部添加斜线 -

这篇文章不错——代码规范

该文章来自于阿里巴巴技术协会(ATA)精选文章. 个人经历 对我代码质量影响最大的是在一家外资企业,在这家公司我觉得有以下几个方面做的很不错. 团队编码风格统一 统一到什么程度? 不看代码作者,你很难区分代码是谁写的(在目前公司一些团队也能达到这个标准). 个人观点: 这样做有什么好处?团队中每个人阅读代码都很容易,减少很多沟通,维护成本( 代码阅读的次数远远大于变更的次数),并且心情非常愉悦.有人肯定觉得愉悦有点夸张,举个栗子: 有一些代码,如果不是由于与工作内容有关联,你是否有种这辈子都不情

作业三: 是否需要有代码规范?

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

我认为需要代码规范

我认为需要代码规范.代码规范可以给我们检查和修改提供方便.因为格式语句都是规范的自己好找,也好改.而且现在大多数都是自己写,以后如果分组做东西,或者工作了一个队伍一起做项目,代码规范就更重了,如果没有规范,大家按照自己的习惯风格或者当时的心情写的话,一个团队很难高效,也会给每个人带来困扰和不便.所以大家都按照统一的法则,按照规范写就很容易合作. 1.  这些规范都是官僚制度下产生的浪费大家时间.影响人们开发效率,浪费时间的东西. 反对:我不同意这样的看法.要求代码规范看似给了程序员束缚,让人觉得