资讯频道 → 编程语言
阅读更多

30顶
3踩

编程语言

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

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

　　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也许是最普遍的一条编程原则，我从未发现一个开发人员认为编写重复的代码是件好事。但是我发现一些开发人员在编写单

  • 基于纯verilogFPGA的双线性差值视频缩放 功能：利用双线性差值算法，pc端HDMI输入视频缩小或放大，然后再通过HDMI输出显示，可以任意缩放 缩放模块仅含有ddr ip，手写了 ram,f

    基于纯verilogFPGA的双线性差值视频缩放 功能：利用双线性差值算法，pc端HDMI输入视频缩小或放大，然后再通过HDMI输出显示，可以任意缩放。 缩放模块仅含有ddr ip，手写了 ram,fifo 代码，可以较为轻松地移植到其他平台。 硬件平台：易灵思 ti60f225 EDA平台：efinity

  • 【java毕业设计】智慧社区智慧社区管理员密码修改与重置系统（源代码+论文+PPT模板）.zip

    zip里包含源码+论文+PPT,有java环境就可以运行起来 ,功能说明： 文档开篇阐述了随着计算机技术、通信技术和网络技术的快速发展，智慧社区门户网站的建设成为了可能，并被视为21世纪信息产业的主要发展方向之一 强调了网络信息管理技术、数字化处理技术和数字式信息资源建设在国际竞争中的重要性。 指出了智慧社区门户网站系统的编程语言为Java，数据库为MYSQL，并实现了新闻资讯、社区共享、在线影院等功能。 系统设计与功能： 文档详细描述了系统的后台管理功能，包括系统管理模块、新闻资讯管理模块、公告管理模块、社区影院管理模块、会员上传下载管理模块以及留言管理模块。 系统管理模块：允许管理员重新设置密码，记录登录日志，确保系统安全。 新闻资讯管理模块：实现新闻资讯的添加、删除、修改，确保主页新闻部分始终显示最新的文章。 公告管理模块：类似于新闻资讯管理，但专注于主页公告的后台管理。 社区影院管理模块：管理所有视频的添加、删除、修改，包括影片名、导演、主演、片长等信息。 会员上传下载管理模块：审核与删除会员上传的文件。 留言管理模块：回复与删除所有留言，确保系统内的留言得到及时处理。

  • 基于51单片机的一个智能密码锁设计.7z

    基于51单片机的一个智能密码锁设计.7z

  • 《STM32单片机+2x180-SG90+2x360-SG90+OLED屏幕》源代码

    《基于STM32的舵机控制系统设计》毕业设计项目 1.STM32单片机+2x180_SG90+2x360_SG90+OLED屏幕 2.OLED屏幕显示舵机的方向、速度、角度各项数据 3.按键1：控制180度舵机正向转动角度      4.按键2：控制180度舵机反向转动角度 5.按键3：控制360度舵机正向转动并且控制舵机速度      6.按键4：控制360度舵机反向转动并且控制舵机速度 7.代码里面含有注释 8.硬件实物接上线就能直接运行

  • pyside6-qml-modern-uiapp

    Pyside6+Qml+QtCreator做的桌面app

  • 基于深度堆叠卷积神经网络的图像融合详细文档+全部资料+优秀项目+源码.zip

    【资源说明】 基于深度堆叠卷积神经网络的图像融合详细文档+全部资料+优秀项目+源码.zip 【备注】 1、该项目是个人高分项目源码，已获导师指导认可通过，答辩评审分达到95分 2、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 3、本项目适合计算机相关专业(人工智能、通信工程、自动化、电子信息、物联网等)的在校学生、老师或者企业员工下载使用，也可作为毕业设计、课程设计、作业、项目初期立项演示等，当然也适合小白学习进阶。 4、如果基础还行，可以在此代码基础上进行修改，以实现其他功能，也可直接用于毕设、课设、作业等。 欢迎下载，沟通交流，互相学习，共同进步！

  • 基于卷积神经网络的语音识别声学模型的研究详细文档+全部资料+优秀项目+源码.zip

    【资源说明】 基于卷积神经网络的语音识别声学模型的研究详细文档+全部资料+优秀项目+源码.zip 【备注】 1、该项目是个人高分项目源码，已获导师指导认可通过，答辩评审分达到95分 2、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 3、本项目适合计算机相关专业(人工智能、通信工程、自动化、电子信息、物联网等)的在校学生、老师或者企业员工下载使用，也可作为毕业设计、课程设计、作业、项目初期立项演示等，当然也适合小白学习进阶。 4、如果基础还行，可以在此代码基础上进行修改，以实现其他功能，也可直接用于毕设、课设、作业等。 欢迎下载，沟通交流，互相学习，共同进步！

  • IndexOutOfBoundsException(解决方案).md

    IndexOutOfBoundsException(解决方案)

  • Mini-Imagenet数据集文件

    Mini-Imagenet数据集文件

  • 时间转换工具（BD时、GPS时、UTC时、北京时间相互转换，可计算日期）

    时间转换工具（BD时、GPS时、UTC时、北京时间相互转换，可计算日期）

  • 基于CNN神经网络实现的正方教务系统的验证码识别资料齐全+高分项目+文档+源码.zip

    【资源说明】 基于CNN神经网络实现的正方教务系统的验证码识别资料齐全+高分项目+文档+源码.zip 【备注】 1、该项目是个人高分项目源码，已获导师指导认可通过，答辩评审分达到95分 2、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 3、本项目适合计算机相关专业(人工智能、通信工程、自动化、电子信息、物联网等)的在校学生、老师或者企业员工下载使用，也可作为毕业设计、课程设计、作业、项目初期立项演示等，当然也适合小白学习进阶。 4、如果基础还行，可以在此代码基础上进行修改，以实现其他功能，也可直接用于毕设、课设、作业等。 欢迎下载，沟通交流，互相学习，共同进步！

  • 西北工业大学 人工智能程序设计 Python NOJ程序源代码.zip

    西北工业大学 人工智能程序设计 Python NOJ程序源代码.zip

  • 车辆、飞机、船检测12-YOLO（v5至v11）、COCO、CreateML、TFRecord、VOC数据集合集.rar

    车辆、飞机、船检测12-YOLO（v5至v11）、COCO、CreateML、TFRecord、VOC数据集合集.rar对象检测分配-V2 2024-03-10 7:04 pm ============================= *与您的团队在计算机视觉项目上合作 *收集和组织图像 *了解和搜索非结构化图像数据 *注释，创建数据集 *导出，训练和部署计算机视觉模型 *使用主动学习随着时间的推移改善数据集 对于最先进的计算机视觉培训笔记本，您可以与此数据集一起使用 该数据集包括2992张图像。 以可可格式注释船舶飞机。 将以下预处理应用于每个图像： *像素数据的自动取向（带有Exif-Arientation剥离） *调整大小为640x640（拉伸） 没有应用图像增强技术。

  • 基于SpringBoot2/3+Sa-Token+Mybatis-Plus和Vue3+Ant Design Vue+Uni-App+Uni-UI，并以高质量代码为核心，简洁、高效、安全的快速开发平台

    SmartAdmin以「高质量代码」为核心，「简洁、高效、安全」的快速开发平台；基于SpringBoot2/3+Sa-Token+Mybatis-Plus和Vue3 +Ant Design Vue+UniApp (提供JavaScript和TypeScript双版本、Java8和java17双版本)；满足三级等保、网络安全、数据安全等功能要求。并重磅开源千余家企业在使用的《高质量代码规范》等

Global site tag (gtag.js) - Google Analytics