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

30顶
3踩

编程语言

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

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

　　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 条 请登录后发表评论
3 楼 gu__sofia 2011-07-18 19:25
不错 很受用
2 楼 yzhw 2011-07-18 18:45
很受用  
1 楼 yoyo837 2011-07-18 17:23
我目前的思维面向接口写得很干涩...

发表评论

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

相关推荐

  • 分布式计算的基本原理

    分布式计算的基本原理 转载时请注明出处：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也许是最普遍的一条编程原则，我从未发现一个开发人员认为编写重复的代码是件好事。但是我发现一些开发人员在编写单

  • LTspice仿真：LDO电源电路学习与实践的利器

    内容概要：本文详细介绍了如何利用LTspice进行LDO（低压差线性稳压器）电源电路的仿真。首先讲解了如何导入LDO模型并配置仿真环境，接着深入探讨了瞬态分析、相位裕度、电源抑制比(PSRR)等关键仿真的具体步骤和注意事项。文中提供了多个实用的操作技巧，如通过调整补偿电容优化相位裕度，以及使用.step param命令批量测试不同参数的影响。此外，还分享了一些常见的仿真误区及其解决方法，帮助读者更好地理解和掌握LDO的设计与调试。 适合人群：电子工程专业学生、电源电路设计初学者、希望深入了解LDO特性的工程师。 使用场景及目标：适用于希望通过仿真工具提高LDO设计技能的人群。主要目标是掌握LDO的基本工作原理，学会使用LTspice进行各种类型的仿真分析，从而优化电路设计，确保系统的稳定性和性能。 其他说明：文章不仅提供详细的仿真步骤和技术细节，还附带了作者的实际经验和常见问题解决方案，使读者能够在实践中不断改进自己的设计思路。

  • 渝安集团员工职业发展通道设计方案.ppt

    渝安集团员工职业发展通道设计方案.ppt

  • 新能源电动汽车VCU与BMS的HIL硬件在环仿真技术及其模块化建模

    内容概要：本文详细介绍了新能源电动汽车中VCU（整车控制器）和BMS（电池管理系统）的HIL（硬件在环）仿真技术。首先阐述了整车建模的基础，包括电池、电机等关键部件的建模要点。接着分别解析了驾驶员模块、仪表模块、BCU整车控制器模块、MCU电机模块、TCU变速箱模块、BMS电池管理模块等多个子模块的功能和实现方式。最后强调了HIL仿真在电动汽车控制系统测试和优化中的重要性，特别是在降低成本和风险方面的作用。 适合人群：从事新能源汽车研发的技术人员，尤其是专注于VCU和BMS领域的工程师。 使用场景及目标：适用于需要深入了解电动汽车控制系统仿真技术的研发团队，在产品开发初期进行系统测试和优化，确保各子系统间的协同工作正常。 其他说明：文中提供了大量代码示例，帮助读者更好地理解和实践相关概念和技术细节。此外，还分享了一些实际项目中的经验和教训，如故障注入测试的具体应用场景等。

  • 如何应对一线人员春节后的离职潮.docx

    如何应对一线人员春节后的离职潮

  • 线性代数_GitHub_课件作业_教学辅助用途_1742837800.zip

    线性代数

  • 离职面谈表.xls

    离职面谈表.xls

  • 聚宽对接qmt大礼包，帮助你配置好交易实盘环境

    聚宽对接qmt大礼包，配备需要的全部软件：python3.9版本，qmt模拟安装包，pycharm安装包，talib包

  • 试用期转正表.xls

    试用期转正表.xls

  • 招聘数据分析.xls

    招聘数据分析.xls

  • 如何让新员工快速融入团队.docx

    如何让新员工快速融入团队

  • 电力电子仿真中并离网逆变器及无功补偿设备的控制策略与建模

    内容概要：本文详细介绍了并离网逆变器的两种主要控制策略——PQ控制和V/f控制，以及无功能量发生器(SVG)和有源电力滤波器(APF)的仿真模型。对于PQ控制，文章展示了如何将功率指令转化为电流指令，并强调了电网电压定向和限幅处理的重要性。V/f控制则用于离网模式，通过调节电压和频率来维持系统的稳定。SVG主要用于无功补偿，通过实时计算无功需求进行补偿。APF则专注于谐波检测和消除，利用自适应滤波器提高效率。此外，文中还提供了多个实用的小技巧，如仿真步长设置、模式切换时的前馈补偿等。 适合人群：从事电力电子仿真研究的技术人员，尤其是对逆变器控制策略感兴趣的工程师。 使用场景及目标：适用于需要深入理解和实现逆变器控制策略的研究项目，帮助工程师优化仿真模型，提升系统性能，确保仿真结果的准确性。 其他说明：文章不仅提供了详细的代码片段，还分享了许多实践经验，有助于读者避免常见错误，提高仿真成功率。

  • Carsim与Simulink联合仿真中基于线性二自由度模型的卡尔曼滤波(KF)实现及优化

    内容概要：本文详细介绍了如何利用Carsim与Simulink进行联合仿真，通过线性二自由度模型和卡尔曼滤波（KF）来估计车辆的质心侧偏角和横摆角速度。首先搭建了联合仿真框架，Carsim提供车辆状态量，Simulink负责算法处理。文中展示了线性二自由度模型的状态方程及其参数设定，并深入探讨了KF的两种实现方式：S函数编程和Simulink内置模块。对于S函数实现，着重讲解了状态转移矩阵的动态更新以及噪声矩阵Q的调整策略，确保模型能够适应车速变化。而对于内置模块，则指出了其在灵活性方面的不足之处。此外，还讨论了联合仿真的配置要点，如数据接口同步、采样时间和信号处理等问题。 适合人群：从事车辆动力学研究、控制理论应用、自动化控制领域的工程师和技术人员。 使用场景及目标：适用于需要精确估计车辆质心侧偏角和横摆角速度的研究和开发项目，特别是在涉及ESP等主动安全系统的开发过程中。目标是提高估计精度，增强系统的鲁棒性和响应速度。 其他说明：文章提供了详细的代码片段和实践经验分享，帮助读者更好地理解和实施相关技术。建议在实际应用中根据具体需求选择合适的KF实现方式，并注意处理各种边界条件和异常情况。

  • 档案管理[03].pptx

    档案管理[03]

  • 风电与储能联合调频系统：基于Python的建模与优化

    内容概要：本文详细介绍了风电与储能联合调频系统的原理及其优化方法。首先解释了风电输出功率的波动性和对电网频率的影响，提出储能系统作为解决方案。文中展示了如何用Python生成风速数据并构建调频控制系统，重点讨论了PID控制器的设计以及SOC（荷电状态）管理策略。此外，还探讨了调频控制逻辑、硬件在环测试、风电功率预测模型（如LSTM）、调频效果验证方法及储能系统的物理限制等问题。最后强调了模型验证的重要性，提出了异常数据注入测试的方法。 适合人群：从事电力系统自动化、新能源发电及储能技术研发的专业人士，尤其是有一定编程基础的研究人员和技术工程师。 使用场景及目标：适用于需要理解和实施风电与储能联合调频项目的团队。主要目标是提高电网稳定性，减少风电波动带来的负面影响，同时延长储能系统的使用寿命。 其他说明：文中提供了大量实用的Python代码示例，涵盖了从数据生成到控制逻辑实现再到模型验证的全过程。对于希望深入理解风储调频系统的工作机制和技术挑战的人来说，是一份非常有价值的参考资料。

Global site tag (gtag.js) - Google Analytics