阅读更多

30顶
3踩

编程语言

翻译新闻 编写好代码的10条戒律

2011-07-18 15:36 by 见习编辑 jobbole 评论(23) 有14834人浏览

  1. DRY: 不要重复你自己(Don’t repeat yourself)

  DRY是一条最容易理解但又是相对比较难以应用的原则。它是指当你在两处或者更多的地方发现相似代码时,我们应当把它们抽象成一个新的函数,在之前重复的地方调用新的函数并带上适当的参数。

  DRY也许是最普遍的一条编程原则,我从未发现一个开发人员认为编写重复的代码是件好事。但是我发现一些开发人员在编写单元测试时忘记了这条原则,例如:设想一下你改变了一个类的接口,之前已经为这个类编写了很多的单元测试,如果你没有应用DRY原则,这时你需要手动去修改所有使用这个类接口的调用,来与每一个测试实例的新签名匹配。


  2. 编写短小的函数/方法

  有三个非常好的理由,选择编写短小的函数。

  • 1. 代码会更容易阅读。
  • 2. 代码会更容易重用(短小的函数更容易产生松耦合)。
  • 3. 代码会更易于测试。


  编者注:松耦合:在软件领域中,“耦合”一般指软件组件之间的依赖程度。耦合度松的软件会有较好的扩展性。


  3. 给类、函数和变量使用好的命名

  直接使用其他开发者的代码而不需要阅读说明文档,没有什么比这更好的事情了,因为代码中的类名、函数名已经能够告诉我们所有需要的信息。所以,采用这种方法,每次在为你的代码中任何元素进行命名的之前请花上几秒钟(思考),这会让大家的生活变得更轻松。


  4. 为每个类分配正确的职责

  一个类只承担一个职责(单一权责),听起来和有些人知道的SOLID原则很相似,但是这里不是指任意的职责,而是正确的职责。所以,如果我们要设计一个顾客类,我们不会给它创建一个销售的行为,我们只会让它处理所有与一个客户相关的数据。

  编者注:SOLID:面向对象设计的五项原则 (是SRP单一职责原则、OCP开闭原则、LSP李式代换原则、ISP依赖反转原则和 DIP接口分离原则,首字符的缩写)。


  5. 保持代码的条理性

  代码条理性分两个层次

  • 物理上的条理性:无论你采用了哪种结构,包、命名空间、文件夹等等,用一种更容易并且凭直觉就能找到代码存放在哪里的方式来组织你编写的类。
  • 逻辑上的条理性:不论逻辑上从属关系如何,(只要有逻辑从属关系)类都应该能够互相访问彼此的成员变量,但是如果从属于不同的逻辑结构就应当只能通过接口来访问。这种逻辑分组通常会被实现成(逻辑)层、服务等。


  6. 编写很多的单元测试

  测试越多越好,它们是所有代码变动的安全保证,我们会在将来的某一天需要运行这些测试代码。


  7. 尽早且经常地重构代码(Refactor often and sooner)

  软件开发是一个持续发现的过程,为了编写保持与新增/改变的需求匹配的高质量代码,随着开发的进行,重构代码是必不可少的。由于重构是一项带有风险的任务,需要有两个主要的前提条件,来避免由于重构给系统引入新的错误。

  • 1. 编写很多的单元测试
  • 2. 每一次重构的幅度要比较小。在开发软件过程中,开始重构2000行代码,3个小时以后发现所有的代码都不能工作,并且导致问题的原因无从查找,因此需要恢复到最初版本,几乎没什么事能比这更让人抓狂了。


  8. 注释是恶魔

  这条特殊戒律有一点争议,我们大多数人学到的是“注释是一个好的习惯”,并且在一段晦涩的代码中有一段注释会比仅仅只有代码好的多,这里我的观点是:给晦涩的代码加注释还不如仅仅留下代码,只需要重构这段代码直到它变得可读为止。(编注:当然了,除了作者说的这种类型的代码,在其他情况下,还是得添加必要的注释,这不仅方便自己日后查看,更有利于后来者维护,请参阅《提高代码可读性的10个注释技巧 》一文。


  9. 要面向接口编程,不要面向实现编程(Code to an interface, not to an implementation)

  这是一条经典的原则,面向接口编程会让我们从实现的细节中解放出来,我们只要定义一个协议,并且依据协议调用定义的操作,期望(对方,即被调用的代码)能把实际的实现或者运行时态的实现传递给我们的代码。


  10. 对代码进行复查

  我们都会犯错误,没有什么能比请别人对我们代码做一个非正式快速复查更好的办法来查找错误了。最好不要等到代码都完成以后再复查,当某些重要部分的代码完成后,或者离上一次复查相隔几天之后,就进行复查。


  原文:Alberto Gutierrez   翻译:伯乐在线 敏捷翻译 - 唐尤华

来自: www.jobbole.com
30
3
评论 共 23 条 请登录后发表评论
23 楼 雪飘寒 2011-11-09 11:11
aystnd 写道
LubinJava 写道
什么是面向对象编程,
在天朝,一切都是面向现实编程.

文章是讨论如何写好代码,你非要扯上其他的,有牢骚不要在这里抱怨,抱怨只能说明你这人不是个纯粹做技术的。


看了一下,理论上都是正确的,很好,不过实际中就不是这么回事了,什么东西都要联系实际。
人家怎么怎么叫扯到别的上面了,人家说的是实话,是实际,总比空谈这些理论好吧。
22 楼 aystnd 2011-07-25 11:08
LubinJava 写道
什么是面向对象编程,
在天朝,一切都是面向现实编程.

文章是讨论如何写好代码,你非要扯上其他的,有牢骚不要在这里抱怨,抱怨只能说明你这人不是个纯粹做技术的。
21 楼 taolei0628 2011-07-23 10:55
我很少写注释,但我认为这是我做得不好的地方。
代码能写到不用注释就能读懂?太不现实了。

引用8楼的看法:
第8条有什么想不通的,干净的代码无需太多注释,每一个类名,每一个函数名,每一个对齐的格式,本身就是最好的注释。只有垃圾代码,才靠大量注释来解释其含义,并且难改,也容易出bug,更严重的是:有时候你代码改了,注释没改,这样反而会引起误解!

程序写的烂不是注释的错。按你的理解,JDK的源代码就是烂的不能再烂的代码了。
20 楼 hellolaojiang 2011-07-20 13:19
LubinJava 写道
什么是面向对象编程,
在天朝,一切都是面向现实编程.

   
19 楼 LubinJava 2011-07-20 09:55
什么是面向对象编程,
在天朝,一切都是面向现实编程.
18 楼 lvhjean 2011-07-20 08:13
同意 17楼 的观点 工作中 一大部分都是做 面向现实的
17 楼 boyuliu 2011-07-19 21:42
公司大部分代码都是面向现实, 每天被细节所引发出的问题而煎熬着
16 楼 别惹Java 2011-07-19 20:08
单元测试不怎么写
15 楼 jiushiyouke 2011-07-19 18:29
《重构》+《代码整洁之道》的总结
14 楼 walkintojava 2011-07-19 17:37
注释可以用方法名,类名, 以及代码本来来代替。
13 楼 lyzhanghai 2011-07-19 17:03
骨之灵魂 写道
说的不错。
第8条的意思是 当你认为加上注释才能让别人理解这段代码时,说明这段代码需要重构了。

《重构》的那本书上就是这么写的
12 楼 geminiyellow 2011-07-19 15:30
spring
11 楼 骨之灵魂 2011-07-19 12:37
说的不错。
第8条的意思是 当你认为加上注释才能让别人理解这段代码时,说明这段代码需要重构了。
10 楼 parchingo 2011-07-19 11:29
作为一个初学者来说,我的代码总是有点乱,想到哪里就写到哪里,看了这东西后相当有感触,谢谢分享!
9 楼 微雨心晴 2011-07-19 10:23
第八条严格来讲是正确的!但这个正确是有条件的!初学者一定要注意被误导!
完整解释在我的微博上,就不写了:http://weibo.com/sharedata
8 楼 niva 2011-07-19 10:16
第8条有什么想不通的,干净的代码无需太多注释,每一个类名,每一个函数名,每一个对齐的格式,本身就是最好的注释。只有垃圾代码,才靠大量注释来解释其含义,并且难改,也容易出bug,更严重的是:有时候你代码改了,注释没改,这样反而会引起误解!
7 楼 smilebomb 2011-07-19 09:49
唉,第8条,让人想不通,本人持有相反的意见
6 楼 yjc2020 2011-07-19 09:16
注释写的明白就有用,否则没神马用
5 楼 liu.anxin 2011-07-19 08:46
看过一些人写的注释, 敷衍的那种. 看老半天不知道注释上写的到底什么意思, 具体的还得去看代码.
4 楼 allenny 2011-07-19 03:15
不同意注释那一条

发表评论

您还没有登录,请您登录后再发表评论

相关推荐

  • 分布式计算的基本原理

    分布式计算的基本原理 转载时请注明出处:http://blog.csdn.net/absurd 从最近几次MMI设计会议讨论的结果来看,嵌入式程序员对于分布式计算知之甚少。他们对分布式计算有种恐惧,所以对分布式架构极力排斥。而他们的人数又占绝对优势,讨论N次,MMI的架构还是没有确定下来。分布式计算已经进入桌面环境,不是企业应用的专利了,像GNOME(GNU Network Objec...

  • 分布式计算 ——原理、算法与系统(Distributed Computing —— Principles, Algorithms, and System)读书笔记 持续更新

    分布式计算 ——原理、算法与系统 Distributed Computing —— Principles, Algorithms, and System 不定期更新   第一章 引言 第二章 分布式计算模型   第一章 引言 分布式系统:处理器、存储器、通信网络 1.4 与并行多处理器/多计算机系统的关系 并行系统:通过将计算任务在多个处理器之间进行分配,从而获得...

  • 分布式技术原理(七):分布式计算

    目录 分布式计算 什么是分而治之? 分治法的原理 MapReduce 工作原理 MapReduce 实践应用 总结 分布式计算模式之Stream Stream 工作原理 分布式计算 Hadoop 这个框架主要用于解决海量数据的计算问题。那么,它是如何做到海量数据计算的呢?你可能会想,既然是海量数据,规模这么大,那就分成多个进程,每个进程计算一部分,然后汇总一下结果,就可以提升运算速度了。其实,整个计算流程,我们可以很形象地用一个词来解释,就是“同流合污“,在分布式领域中就叫作 MR 模式

  • 分布式系统设计系列 -- 基本原理及高可用策略

    分布式系统设计系列之 -- 基本原理及高可用策略篇 这篇文章主要介绍一些入门的概念和原理,后面带来一些高可用、数据分布的实践方法!

  • 编写好的代码的10条戒律

    1. DRY: 不要重复你自己(Don’t repeat yourself)  DRY是一条最容易理解但又是相对... DRY也许是最普遍的一条编程原则,我从未发现一个开发人员认为编写重复的代码是件好事。但是我发现一些开发人员在编写单

  • JEDEC SPEC 最新版 合集 DDR2/DDR3/DDR4/DDR5/LPDDR2/LPDDR3/LPDDR4(X)/LPDDR5(X)

    JESD79-2F DDR2 JESD79-3F DDR3 JESD79-4D DDR4 JESD79-5C DDR5 JESD209-2F LPDDR2 JESD209-3C LPDDR3 JESD209-4E LPDDR4 JESD209-4-1A LPDDR4X JESD209-5C LPDDR5(X)

  • COMSOL二维光子晶体角态研究:单胞与超胞能带计算及边界态与角态特性分析,COMSOL二维光子晶体角态研究:单胞与超胞能带计算及边界态与角态特性分析,comsol二维光子晶体角态 单胞能带,超胞能

    COMSOL二维光子晶体角态研究:单胞与超胞能带计算及边界态与角态特性分析,COMSOL二维光子晶体角态研究:单胞与超胞能带计算及边界态与角态特性分析,comsol二维光子晶体角态。 单胞能带,超胞能带,边界态以及角态计算。 ,comsol;二维光子晶体;角态;单胞能带;超胞能带;边界态计算,基于Comsol的二维光子晶体角态及能带边界计算研究

  • 六自由度机械臂抓取动作仿真与代码解析:抓取动画、关节参数变化及轨迹图解详解,六自由度机械臂抓取动作仿真指南:掌握两套代码实现动画与轨迹图模拟学习攻略,六自由度机械臂抓取动作仿真-8 两套关于抓取动作的

    六自由度机械臂抓取动作仿真与代码解析:抓取动画、关节参数变化及轨迹图解详解,六自由度机械臂抓取动作仿真指南:掌握两套代码实现动画与轨迹图模拟学习攻略,六自由度机械臂抓取动作仿真-8 两套关于抓取动作的代码,包括抓取动画、关节角、角速度、角加速度的变化仿真、以及抓取轨迹图 简单易懂好上手~ ,六自由度机械臂;抓取动作仿真;抓取动画;关节角变化;角速度角加速度;抓取轨迹图;两套代码;简单易懂好上手,六自由度机械臂抓取动作仿真演示:代码与轨迹图解

  • ITC网络广播工具软件

    ITC网络广播工具软件

  • Multisim四位密码锁电路仿真设计:设定、开锁与声光报警功能演示资料包,Multisim四位密码锁电路仿真设计:设定、输入、开锁与报警功能详解,附源文件、原理说明书与演示视频,multisim四位

    Multisim四位密码锁电路仿真设计:设定、开锁与声光报警功能演示资料包,Multisim四位密码锁电路仿真设计:设定、输入、开锁与报警功能详解,附源文件、原理说明书与演示视频,multisim四位密码锁电路仿真设计 功能: 1.通过拨码开关1进行初始密码设定。 2.通过拨码开关2输入密码,实现开锁判断。 3.如果密码正确,LED绿灯亮,表示开锁。 4.如果密码不正确,LED红灯亮,蜂鸣器鸣叫,声光报警。 资料包含:仿真源文件+原理说明书+演示视频 ,四位密码锁电路、Multisim仿真设计、初始密码设定;拨码开关输入;开锁判断;LED灯显示;声光报警;仿真源文件;原理说明书;演示视频,Multisim四位密码锁电路仿真设计:初始密码设置与智能解锁功能的声光报警展示

  • 上班摸鱼打卡模拟器微信小程序源码.zip

    俗话说,摸鱼摸的好,上班没烦恼,毕竟谁能拒绝带薪拉屎呢(手动狗头) 这是一个云开发职场打工人专属上班摸鱼划水微信小程序源码,没有后台 直接导入微信开发者工具即可运行,UI简约大气漂亮,只需登录微信公众平台配置完合法域名即可轻松上线。 用户进入摸鱼小程序,可以自由设置薪资,上班时间、下班时间、发薪日、 月工作天数以提醒自己摸鱼,全民打酱油,让自己成为摸鱼冠军,《商鞅摸鱼哲学》 摸鱼不是自我放纵,而是个人实力的积蓄,我们的小目标是晚睡晚起 小程序中的今日待办会提醒用户带薪拉屎和闲逛,下方展示的是距离休息日的天数,距离下一次发工资的天数和节日的天数。

  • 【毕业设计】基于Java的开发的一个集合校园二手交易、拼车、失物招领等功能的app_pgj.zip

    【毕业设计】基于Java的开发的一个集合校园二手交易、拼车、失物招领等功能的app_pgj

  • PICkit3离线烧录流程

    个人记录:PICkit3离线烧录流程 使用软件:MPLAB X IDE v5.30 记录时间:20250215

  • 基于Matlab代码的电力系统状态估计与实验仿真研究:扩展卡尔曼滤波和无迹卡尔曼滤波在电力系统动态状态估计中的应用及效果分析,Matlab仿真实验研究:基于扩展卡尔曼滤波器与无迹卡尔曼滤波器对电力系统

    基于Matlab代码的电力系统状态估计与实验仿真研究:扩展卡尔曼滤波和无迹卡尔曼滤波在电力系统动态状态估计中的应用及效果分析,Matlab仿真实验研究:基于扩展卡尔曼滤波器与无迹卡尔曼滤波器对电力系统状态估计的影响及验证,状态估计 电力系统状态估计 Matlab代码 实验仿真研究 电力系统由于测量值和传输误差,还有测量噪声的影响,会对状态估计产生影响。 因此,需要对嘈杂的测量进行滤波,以获得准确的电力系统运行动态。 本文使用扩展卡尔曼滤波器(EKF)和无迹卡尔曼滤波器(UKF)来估计电力系统的动态状态。 扩展卡尔曼滤波EKF、无迹卡尔曼滤波UKF 利用扩展的无迹卡尔曼滤波器估计了动力系统的动态状态。 对WECC 3机9总线系统和新英格兰10机39总线系统进行了案例研究。 结果表明EKF和UKF都能准确地估计电力系统的动态状态。 ,核心关键词:状态估计; 电力系统状态估计; Matlab代码; 实验仿真; 测量值误差; 测量噪声; 扩展卡尔曼滤波器(EKF); 无迹卡尔曼滤波器(UKF); 动力系统; 动态状态估计; WECC 3机9总线系统; 新英格兰10机39总线系统。,Matlab

  • springboot在线考试--.zip

    springboot在线考试--

  • 台达DVP EH3与MS300 PLC&变频器通讯程序的全面解决方案,台达DVP EH3与MS300通讯程序:稳定可靠的频率控制与启停管理系统,台达DVP EH3与台达MS300通讯程序(TDEH-9

    台达DVP EH3与MS300 PLC&变频器通讯程序的全面解决方案,台达DVP EH3与MS300通讯程序:稳定可靠的频率控制与启停管理系统,台达DVP EH3与台达MS300通讯程序(TDEH-9) 可直接用于实际的程序,程序带注释,并附送触摸屏程序,有接线方式和设置,通讯地址说明等。 程序采用轮询,可靠稳定 器件:台达DVP EH3系列PLC,台达MS300系列变频器,昆仑通态7022Ni 功能:实现频率设定,启停控制,实际频率读取,加减速时间设定。 资料:带注释程序,触摸屏程序,接线和设置说明,后续有技术咨询。 ,核心关键词:台达DVP EH3; 台达MS300; 通讯程序(TDEH-9); 轮询; 稳定; 频率设定; 启停控制; 实际频率读取; 加减速时间设定; 触摸屏程序; 接线方式; 设置说明; 技术咨询。,台达PLC与变频器通讯程序(带注释、触摸屏控制)

  • 【python毕设】p100基于Pytorch+springboot+vue的声纹识别系统.zip

    项目资源包含:可运行源码+sql文件 适用人群:学习不同技术领域的小白或进阶学习者;可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。项目具有较高的学习借鉴价值,也可拿来修改、二次开发。 个人账户管理:支持用户注册、登录与个人信息编辑;提供密码找回及账号安全保护措施。 声纹采集:利用麦克风设备录制用户的声纹样本;支持多种录音格式和质量调整,确保采集到清晰、准确的声纹数据。 声纹模板库管理:建立和维护一个安全的声纹模板库;支持声纹模板的添加、删除、更新和查询操作。 声纹比对与识别:运用深度学习算法对输入的声纹数据进行特征提取和匹配;实现快速、准确的声纹身份验证。 多场景应用支持:适用于多种场景,如门禁系统、移动支付、远程登录等;可根据实际需求定制开发相应的应用场景。 实时监控与报警:实时监控系统运行状态,包括声纹识别成功率、处理速度等指标;当出现异常情况时,及时发出报警信息。 数据分析与报告生成:收集并分析声纹识别过程中的数据,如识别准确率、处理时间等;根据用户需求输出包含详细图表说明的专业级文档供下载打印保存。 社区互动交流:设立论坛版块鼓励用户分享心得体会讨论热点话题;定期邀请行业专家举办线上讲座传授实用技巧知识。 音乐筛选与推荐:集成音乐平台API,根据用户的浏览习惯和情绪状态推荐背景音乐,增强用户体验。 数据可视化:提供交互式的数据可视化面板,使非技术用户也能轻松理解复杂的数据集,从而做出更明智的决策。

  • 三相与多相开绕组永磁同步电机仿真模型的先进控制策略探讨与实现,三相与多相开绕组永磁同步电机的Simulink仿真模型与先进控制策略研究,开绕组电机,开绕组永磁同步电机仿真模型、simulink仿真 共

    三相与多相开绕组永磁同步电机仿真模型的先进控制策略探讨与实现,三相与多相开绕组永磁同步电机的Simulink仿真模型与先进控制策略研究,开绕组电机,开绕组永磁同步电机仿真模型、simulink仿真 共直流母线、独立直流母线,两相容错,三相容错控制,零序电流抑制,控制策略很多 三相开绕组永磁同步电机,六相开绕组永磁同步电机 五相开绕组永磁同步电机,五相开绕组电机 ,开绕组电机; 永磁同步电机仿真模型; simulink仿真; 共直流母线; 独立直流母线; 两相容错; 三相容错控制; 零序电流抑制; 控制策略; 六相开绕组永磁同步电机; 五相开绕组永磁同步电机,开绕组电机仿真研究:共直流母线与独立直流母线的容错控制策略

  • 【毕业设计】基于Java的开发的网上汽车租赁管理系统_pgj.zip

    【毕业设计】基于Java的开发的网上汽车租赁管理系统_pgj

Global site tag (gtag.js) - Google Analytics