编程成长过程经验之谈

1.- DRY: Don’t repeat yourself.

DRY 是
一个最简单的法则,也是最容易被理解的。但它也可能是最难被应用的(因为要做到这样,我们需要在泛型设计上做相当的努力,这并不是一件容易的事)。它意味 着,当我们在两个或多个地方的时候发现一些相似的代码的时候,我们需要把他们的共性抽象出来形一个唯一的新方法,并且改变现有的地方的代码让他们以一些合 适的参数调用这个新的方法。

DRY 这一法则可能是编程届中最通用的法则了,目前为止,应该没有哪个程序员对这一法则存有异议。但是,我们却能发现,一些程序在编写单元测试(unit testing)时忘记了这一法则:让我们相像一下,当你改变一个类的若干接口,如果你没有使用DRY,那么,那些通过调用一系例类的接口的unit
test的程序,都需要被手动的更改。比如:如果你的unit test的诸多test cases中没有使用一个标准共有的构造类的方法,而是每个test case自己去构造类的实例,那么,当类的构造函数被改变时,你需要修改多少个test cases啊。这就是不使用DRY法则所带来的恶果。

 

2.- 短小的方法.

至少,我们有下面三个不错的理由要求程序员们写下短小的方法。

  1. 代码会变得更容易阅读。
  2. 代码会变得更容易重用(短方法可以减少代码间的耦合程度)
  3. 代码会变得更容易测试。

3.- 良好的命名规范

使用不错的统一的命名规范可以让你的程序变得更容易阅读和维护,当一个类,一个函数,一个变量的名字达到了那种可以“望文生义”的境界话,我们就可以少一些文档,少一些沟通。文章《编程中的命名设计那点事 》可以给你一些提示。

4.- 赋予每个类正确的职责

一个类,一个职责,这类规则可以参考一下类的S OLID 法则。但我们这里强调的不是一种单一的职责,而是一个正确的职责。如果你有一个类叫Customer,我们就不应该让这个类有sales 的方法,我们只能让这个类有和Customer有最直接关系的方法。

5.- 把代码组织起来

把代码组织起来有两具层次。

  • 物理层组织 :无论你使用什么样的目录,包(package)或名字空间(namespace)等的结构,你需要把你的类用一种标准的方法组织起来,这样可以方便查找。这是一种物理性质的代码组织。
  • 逻辑层组织 : 所谓逻辑层,主要是说,我们如果把两个不同功能的类或方法通过某种规范联系和组织起来。这里主要关注的是程序模块间的接口。这就是我们经常见到的程序模块的架构。

6.- 创建大量的单元测试

单元测试是最接近BUG的地方,也是修改BUG成本最低的地方,同样也是决定整个软件质量好坏的成败的地方。所以,只要有可能,你就应该写更多的,更好的单元测试案例,这样当你未来有相应代码改变的时候,你可以很简单知道你代码的改变是否影响了其它单元。

7.- 经常重构你的代码

软件开发是一种持续的发现的过程,从而让你的代码可以跟上最新的实际需求的变化。所以,我们要经常重构自己的代码来跟上这样的变化。当然,重构是有 风险的,并不是所有的重构都是成功的,也不是我们随时都可以重构代码。下面是两个重构代码的先要条件,以避免让你引入更多的BUG,或是把本来就烂的代码 变得更烂。

  1. 有大量的单元测试来测试。正如前面所说,重构需要用大量的单元测试来做保障和测试。
  2. 每次重构都不要大,用点点滴滴的小的重构来代替那种大型的重构。有太多的时候,当我们一开始计划重构2000行代码,而在3个小时后,我们就放弃这个计划并把代码恢复到原始的版本。所以,我们推荐的是,重构最好是从点点滴滴积累起来的。

8.- 程序注释是邪恶的

这一条一定是充满争议的,大多数程序员都认为程序注释是非常好的,是的,没错,程序注释在理论上是非常不错的。但是,在实际过程序当中,程序员们写 出来的注释却是很糟糕的(程序员的表达能力很有问题),从而导致了程序注释成为了一切邪恶的化身,也导致了我们在阅读程序的时,大多数时候,我们都不读注 释而直接读代码。所以,在这里,我们并不是鼓励不写注释,而是——如果你的注释写得不够好的话,那么,你还不如把更重要的时间花在重构一下你的代码,让你 的代码更加易读,更加清楚,这比会比注释更好。

9.- 注重接口,而不是实现

这是一个最经典的规则了。接口注重的是——“What”是抽象,实现注重的是——“How”是细节。接口相当于一种合同契约,而实际的细节相当于对 这种合同契约的一种运作和实现。运作是可以很灵活的,而合同契约则需要是相对需要稳定和不变的。如果,一个接口没有设计好而需要经常性的变化的话,那我们 可以试想一下,这代来的后果,这绝对会是一件成本很大的事情。所以,在软件开发和调设中,接口是重中之重,而不是实现。然而我们的程序员总是注重于实现细 节,所以他们局部的代码写的非常不错,但软件整体却设计得相对较差。这点需要我们多多注意。

10.- 代码审查机制

所有人都会出错,一个人出错的概率是很大的,两个人出错的概率就会小一些,人多一些,出错的概率就会越来越小。因为,人多了,就能够从不同的角度看 待一个事情,虽然这样可能导致无效率的争论,但比起软件产品release后出现问题的维护成本,这点成本算是相当值得的。所以,这就是我们需要让不同的 人来reivew代码,代码审查机制不但是一种发现问题的最有效的机制,同时也是一种可以知识共享的机制。当然,对于Code Review来说,下面有 几个基本原则:

  • 审查者的能力一定要大于或等于代码作者的能力,不然,代码审查就成了一种对新手的training。
  • 而且,为了让审查者真正负责起来,而不是在敷衍审查工作,我们需要让审查者对审查过的代码负主要责任,而不是代码的作者。 
  • 另外,好的代码审查应该不是当代码完成的时候,而是在代码编写的过程中,不断地迭代代码审查。好的实践的,无论代码是否完成,代码审核需要几天一次地不断地进行。

我以我个人的语言叙述本文,并加入了我个人的经历,所以,请你在转载时请注意作者和出处,并且,请勿用于商业用途 )

 

原文:

http://cocre.com/?p=1007
时间: 2024-08-28 15:08:48

编程成长过程经验之谈的相关文章

web前端开发经验浅谈:分享看过的书籍和成长过程

文章简介:说说我的web前端之路 分享些前端的好书. WEB前端研发工程师,在国内算是一个朝阳职业,这个领域没有学校的正规教育,大多数人都是靠自己自学成才.本文主要介绍自己从事web开发以来(从大二至今)看过的书籍和自己的成长过程,目的是给想了解JavaScript或者是刚接触JavaScript的朋友,介绍如何通过循序渐进的看书来学习javascript. 一. 入门级 :就是有一定的基础(比如最常见的HTML标签及其属性.事件.方法;最常见的CSS属性;基础的JavaScript编程能力),

asp.net的三层结构在编程的过程中怎么体现?

问题描述 asp.net的三层结构在编程的过程中怎么体现? 我理解的是:在"设计"处布局按钮什么的,在按钮的事件里写方法.主要以前见老师给的网上书店里还有什么book类,comment类了,我不是很理解,因为有文章说asp.net天然是三层,我理解的对吗?求大牛告知. 解决方案 关于ASP.NET的三层结构关于ASP.NET的三层结构ASP.NET中的三层结构 解决方案二: 其实三层不止是三层 我们都称作是三层架构而已 还有Model实体层 和Utility工具层 用于添加实体 你的B

《中国人工智能学会通讯》——11.23 人的视觉成长过程

11.23 人的视觉成长过程 本文主要涉及视觉物体分割的研究(英文文献中一般 object/semantic segmentation.image parsing等词来表示). 视觉物体分割要求所得到的分割具有语义性,由于同一语义目标对应底层图像特征的多样性,例如图 1 中公共汽车就同时包含了白色的车皮.半透明的玻璃.暗红色的车次信息,以及复杂的车身广告图案等颜色纹理差异很大的区域,视觉物体分割一直是计算机视觉领域的基本难题之一. 但是人类视觉却在这一任务上表现出极其优异的性能:人能轻易地判断出

小菜编程成长记(六 工厂不好用了?)

本系列文章导航 四大发明之活字印刷面向对象思想的胜利 小菜编程成长记(一 面试受挫代码无错就是好?) 小菜编程成长记(二 代码规范.重构) 小菜编程成长记(三 复制VS复用) 小菜编程成长记(四 业务的封装) 小菜编程成长记(五 体会简单工厂模式的美妙) 小菜编程成长记(五 体会简单工厂模式的美妙) 小菜编程成长记(五 体会简单工厂模式的美妙) 小菜编程成长记(六 工厂不好用了?) 小菜编程成长记(七 用"策略模式"是一种好策略) 小菜编程成长记(八 反射程序员的快乐!) 小菜编程成长

人的思想的成长过程是一个潜意识不断成长并替代思维完成细节工作的过程

人的思想的成长过程是一个潜意识不断成长并替代思维完成细节工作的过程 太阳火神的美丽人生 (http://blog.csdn.net/opengl_es) 本文禁止转载 本文禁止转载. 潜意识和思维,是人的两个脑,首先了解这个之后,再继续下面的探索过程. ... 最终要论述的一个要点是:潜意识的野指针(学过 C 语言的应该了解野指针,即一块分配出来的内存,其变量或地址指针指向其它新分配的内存了,这块内存再也访问不到了,确被一直占据着)无目地的工作(有些像梦,但这种活动是在清醒的时侯,楞神儿是一种,

彷徨中的成长-记一个文科生的IT成长过程

纠结了许久,要不要写这篇文章,然而最终还是写了.就权当总结与呻吟吧..当然,呻吟最开始还是发在自己的站点的,忍不住手贱,还是想发博客园. 1 剧透 人算不如天算:时隔多年,我竟然搞起了前端. 2 发端 7年前,它进入SYSU学习档案管理. 2.1 UG1 大学一年级,上学期,完全是小白!没有任何的计算机专业知识.没有任何相关课程学习.只记得专业课叫机关文件管理,还有高数.前半年过的各种悠闲. 下学期,初识IT:第一门课是4个学分的大学计算机公共基础.这门课只有第一章配得上基础..第二章数字编码与

斯诺登:今天的孩子成长过程没有丝毫隐私权概念

[导读]"真的想要知道我们的感受, 那么直接来问我们总是会比监听来得更便宜些".斯诺登:今日之新生儿将全无隐私权概念 腾讯科技 瑞雪 12月26日编译在圣诞节来临之际, 美国国家安全局(NSA)告密者爱德华·斯诺登(Edward Snowden)在英国Channel 4频道上露面,向全世界发出了一条另类的圣诞祝福语."出生在今天的孩子在其成长的过程中将丝毫没有隐私权这个概念."曾 曝光美国政府备受争议的监听计划的斯诺登说道."他们永远都不会知道,自己能拥有

教师站长的一些心里话:我的成长过程

中介交易 http://www.aliyun.com/zixun/aggregation/6858.html">SEO诊断 淘宝客 云主机 技术大厅 每个站长要叙说自己的建站史,我想都是满腹的酸甜苦辣,我从2003年开始办网站,那个时候很盲目,只能说是勇气可嘉,呵呵.想想也挺傻的,好家伙,一口气弄了3个站点,实践证明费神费力. 新站长开始的时候我们都是雄心勃勃,不过我认为办站的事情,还是凭着平和的心态来做,毕竟我们站长行业里,绝大部分都是兼职,我们贪多哪个也做不好的.从2006年的时候我抛

地方门户成长过程需要注意的事项

中介交易 http://www.aliyun.com/zixun/aggregation/6858.html">SEO诊断 淘宝客 云主机 技术大厅 题外话:2010年已经过去,2011年悄然而至,今年过年肉吃多少没计算过,酒却是喝了不少,每天醉醺醺的入睡,第二天起来头疼欲裂,想写点文章的心是有,但是一摸到钢笔都不知如何下手,思考不到一顿饭的功夫,又开始准备喝酒吃饭了,如此反复,今日总算可以静下心来好好总结一篇关于地方门户成长中遇到的一些问题,鄙人才学疏浅,但也寻求一些笨方法来待之. 春节