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

30顶
3踩

编程语言

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

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

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

  • 刘嘉怡.中期检查.doc

    刘嘉怡.中期检查.doc

  • COMSOL热电效应模型：基于MATLAB API的热电转换仿真与优化

    内容概要：本文详细介绍了如何使用COMSOL Multiphysics进行热电效应仿真的全过程。首先解释了热电效应的基本概念及其应用场景，如手机充电发烫、吹风机温度升高等。接着，通过具体实例展示了如何在COMSOL中建立热电模型，包括选择合适的物理场（焦耳热和热电效应）、设定材料属性（电导率、导热系数、塞贝克系数）、绘制几何形状以及设置边界条件。文中还提供了详细的MATLAB代码片段用于自动化建模流程，涵盖求解器配置、网格划分、后处理等方面的技术细节。此外，作者分享了一些常见问题的解决方案，如求解器不收敛、网格畸变等。 适合人群：对热电效应感兴趣的科研人员、工程技术人员及高校学生，尤其适用于有一定COMSOL和MATLAB基础的学习者。 使用场景及目标：帮助读者掌握热电效应的基本原理和COMSOL仿真技能，能够独立完成从模型构建到结果分析的完整流程。目标是提高热电转换系统的效率，优化设计参数，探索新材料的应用潜力。 其他说明：文章不仅提供了理论指导，还包括大量实战经验和技术技巧，有助于解决实际建模过程中遇到的问题。

  • 汽车内外饰模具设计规范详解：分型面、斜顶滑块及模架顶出系统的技术要点

    内容概要：本文深入探讨了汽车内外饰模具设计的关键要素，涵盖分型面设计、斜顶和滑块的应用、模架选择以及顶出系统的配置。针对每个部分，不仅提供了理论指导，还辅以Python、MATLAB等编程语言的实际代码示例，帮助理解和实施具体设计方案。例如，分型面设计强调了如何根据产品结构和外观要求确定最佳分型面位置；斜顶和滑块部分讨论了不同类型及其应用场景；模架和顶出系统则关注于结构稳定性和顶出效果的优化。 适合人群：从事汽车模具设计的专业人士，尤其是希望深入了解内外饰模具设计细节的新手设计师和技术人员。 使用场景及目标：适用于汽车内外饰模具设计项目，旨在提高模具设计的精度和效率，减少试错成本，确保产品质量。通过学习本文提供的技术和实践经验，能够更好地应对实际工作中遇到的各种挑战。 其他说明：文中提到的代码示例和经验公式均来源于实际工程案例，具有较高的参考价值。同时，作者还分享了许多宝贵的行业经验和技巧，有助于读者快速掌握模具设计的核心技能。

  • python3.10以上 可安装pyside6（类似pyqt），具体安装操作步骤

    python3.10以上 可安装pyside6（类似pyqt），具体安装操作步骤

  • 【人工智能领域】DeepSeek AI深度探索平台的优势解析：多模态处理、低成本训练与广泛应用场景综述

    内容概要：DeepSeek AI是由杭州深度求索人工智能基础技术研究有限公司于2025年1月20日发布的深度探索AI技术。它具有多模态能力、多语言支持、长上下文理解、领域垂直优化、开源特性等多项技术突破，支

  • IIS配置phpweb服务器所需VC-redist.x64.rar

    IIS配置phpweb服务器所需VC_redist.x64.rar

  • 云南移动5G-A网业战略发展探讨 -创新领航，千帆竞发，共同迈入5G-A新时代.pptx

    云南移动5G-A网业战略发展探讨 -创新领航，千帆竞发，共同迈入5G-A新时代.pptx

  • C#学习之OpenCv实现模版匹配案例

    本文描述了如何使用C#基于OpenCvSharpe实现模版匹配功能，其中实现了下功能： 1、图像加载； 2、模版加载、绘制、保存功能； 3、模版匹配功能。

  • 【软件工程与数据分析】数据结构求职面试问题汇总：涵盖链表、树结构及算法复杂度分析的实战题目解析

    内容概要：本文档汇集了CSci 235软件设计与分析II课程中关于数据结构的面试题，由Stewart Weiss教授整理。文档涵盖了广泛的数据结构主题，包括但不限于链表（如单链表、双向链表、循环链表）、二叉树（如二叉搜索树、最小高度二叉搜索树）、栈、队列等。每个问题都旨在考察求职者对不同数据结构的理解及其应用场景。例如，选择合适的数据结构实现手机通讯录功能，或设计支持撤销功能的文本编辑器。此外，文档还探讨了复杂度分析（Big-O表示法），以及如何优化特定操作的时间复杂度。最后，文档提供了额外的学习资源链接，帮助求职者进一步准备面试。 适合人群：计算机科学专业的学生或有志于从事软件开发工作的求职者，特别是那些希望在技术面试中表现优异的人士。 使用场景及目标：①理解并掌握常见数据结构的基本概念和特性；②学会根据不同场景选择最合适的数据结构；③掌握常见数据结构操作的时间复杂度分析；④为技术面试做充分准备，提高面试成功率。 其他说明：文档中的问题不仅限于理论知识，还包括实际编码练习，建议读者在学习过程中动手实践，以加深理解和记忆。同时，文档提供的额外资源链接可以作为扩展阅读材料，帮助读者更全面地掌握相关知识。

  • 【路径规划】基于matlab A_Star融合灰狼算法GWO求解多仓库机器人送货路径规划【含Matlab源码 13134期】.zip

    Matlab领域上传的视频是由对应的完整代码运行得来的，完整代码皆可运行，亲测可用，适合小白； 1、从视频里可见完整代码的内容 主函数：main.m； 调用函数：其他m文件；无需运行 运行结果效果图； 2、代码运行版本 Matlab 2019b；若运行有误，根据提示修改；若不会，私信博主； 3、运行操作步骤 步骤一：将所有文件放到Matlab的当前文件夹中； 步骤二：双击打开main.m文件； 步骤三：点击运行，等程序运行完得到结果； 4、仿真咨询 如需其他服务，可私信博主； 4.1 博客或资源的完整代码提供 4.2 期刊或参考文献复现 4.3 Matlab程序定制 4.4 科研合作

  • 帆软本地打印插件FinePrint 8.0版本

    帆软本地打印插件FinePrint 8.0版本，适用于FineReport8

  • 【嵌入式控制系统】基于EECS461课程的嵌入式控制技术在汽车领域的应用与发展：从基础概念到未来挑战了文档的主要内容

    内容概要：本文介绍了密歇根大学EECS 461课程——嵌入式控制系统的核心内容及其发展背景。课程旨在教授学生嵌入式控制系统的理论与实践，包括传感器和执行器接口、实时性能和安全要求、混合行为系统、分布式控制网络等方面的知识。文中特别强调了现代汽车作为嵌入式控制系统的典型应用，从1977年到2019年间，汽车技术经历了从模拟控制到微处理器控制的巨大变革，如今的汽车具备了更高效、更环保、更安全的特点。课程还涵盖了S32K144微控制器的开发环境、实验室练习（如数字I/O、PWM信号生成、虚拟墙模拟等）以及自动代码生成工具的使用。 适合人群：具备一定编程基础，特别是对嵌入式系统感兴趣的本科生和研究生，尤其是电气工程、计算机科学专业的高年级学生或硕士生。 使用场景及目标：①了解嵌入式控制系统的基本概念和发展历程；②掌握嵌入式控制系统的设计方法和技术手段，如实时操作系统、中断处理、网络通信协议（CAN）等；③通过实际项目操作，熟悉嵌入式硬件平台和开发工具链的应用。 其他说明：随着汽车行业向智能化、自动化方向发展，对于能够开发复杂嵌入式软件的人才需求日益增长。EECS 461不仅为学生提供了扎实的技术训练，也为他们未来的职业发展打下了坚实的基础。此外，课程还反映了跨学科教育的重要性，鼓励学生打破传统学术界限，培养解决实际问题的能力。

  • C#与Halcon联合编程实现高效视觉几何定位与测量框架

    内容概要：本文详细介绍了如何利用C#与Halcon联合编程构建高效的视觉几何定位与测量框架。主要内容涵盖模板创建与匹配、圆测量、数据持久化以及图像采集等方面的技术细节。首先，通过创建形状模板并进行匹配，实现了工件的精确定位。接着，针对圆形物体的测量，提出了动态ROI绘制、亚像素边缘提取和稳健圆拟合的方法。此外，还讨论了模板管理和图像采集的最佳实践，确保系统的稳定性和高效性。最后，强调了Halcon对象的内存管理和错误处理机制，提供了实用的优化建议。 适合人群：具备一定编程基础，尤其是对C#和Halcon有一定了解的研发人员和技术爱好者。 使用场景及目标：适用于工业生产线上的自动化检测设备开发，旨在提高工件定位和尺寸测量的精度与效率。主要目标是帮助开发者掌握C#与Halcon联合编程的具体实现方法，从而构建稳定可靠的视觉检测系统。 其他说明：文中提供了大量实战代码片段和调试技巧，有助于读者快速理解和应用相关技术。同时，作者分享了许多实际项目中的经验和教训，使读者能够避开常见陷阱，提升开发效率。

  • 【人工智能领域】DeepSeek AI核心技术优势及广泛应用场景：推动全球AI创新与产业变革

    内容概要：本文深入探讨了DeepSeek AI的独特优势及其在全球AI领域的影响力。DeepSeek由中国深度求索公司开发，自2025年1月20日发布以来，凭借其卓越的性能和独特优势迅速吸引了全球关注。其核心优势包括：1) 极致成本效率，如低成本训练和高效推理；2) 强大的推理能力，涵盖多领域表现优异

Global site tag (gtag.js) - Google Analytics