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

30顶
3踩

编程语言

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

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

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

  • 基于Springboot + Mybatis框架实现的一个简易的商场购物系统.zip

    基于springboot的java毕业&课程设计

  • 用于 CNO 实验的 MATLAB 脚本.zip

    1.版本：matlab2014/2019a/2021a 2.附赠案例数据可直接运行matlab程序。 3.代码特点：参数化编程、参数可方便更改、代码编程思路清晰、注释明细。 4.适用对象：计算机，电子信息工程、数学等专业的大学生课程设计、期末大作业和毕业设计。

  • 基于卷积神经网络的垃圾分类.zip

    卷积神经网络（Convolutional Neural Networks, CNNs 或 ConvNets）是一类深度神经网络，特别擅长处理图像相关的机器学习和深度学习任务。它们的名称来源于网络中使用了一种叫做卷积的数学运算。以下是卷积神经网络的一些关键组件和特性： 卷积层（Convolutional Layer）： 卷积层是CNN的核心组件。它们通过一组可学习的滤波器（或称为卷积核、卷积器）在输入图像（或上一层的输出特征图）上滑动来工作。 滤波器和图像之间的卷积操作生成输出特征图，该特征图反映了滤波器所捕捉的局部图像特性（如边缘、角点等）。 通过使用多个滤波器，卷积层可以提取输入图像中的多种特征。 激活函数（Activation Function）： 在卷积操作之后，通常会应用一个激活函数（如ReLU、Sigmoid或tanh）来增加网络的非线性。 池化层（Pooling Layer）： 池化层通常位于卷积层之后，用于降低特征图的维度（空间尺寸），减少计算量和参数数量，同时保持特征的空间层次结构。 常见的池化操作包括最大池化（Max Pooling）和平均池化（Average Pooling）。 全连接层（Fully Connected Layer）： 在CNN的末端，通常会有几层全连接层（也称为密集层或线性层）。这些层中的每个神经元都与前一层的所有神经元连接。 全连接层通常用于对提取的特征进行分类或回归。 训练过程： CNN的训练过程与其他深度学习模型类似，通过反向传播算法和梯度下降（或其变种）来优化网络参数（如滤波器权重和偏置）。 训练数据通常被分为多个批次（mini-batches），并在每个批次上迭代更新网络参数。 应用： CNN在计算机视觉领域有着广泛的应用，包括图像分类、目标检测、图像分割、人脸识别等。 它们也已被扩展到处理其他类型的数据，如文本（通过卷积一维序列）和音频（通过卷积时间序列）。 随着深度学习技术的发展，卷积神经网络的结构和设计也在不断演变，出现了许多新的变体和改进，如残差网络（ResNet）、深度卷积生成对抗网络（DCGAN）等。

  • 基于 Yolov5的检测模型

    运行程序 1、测试.pt模型文件 1.在pycharm里打开下载的yolov5环境，在根目录打开runs文件，找到trains文件中的best_1.pt即为训练最优模型。 2.在根目录找到 detect.py 文件，修改代码221行默认路径至模型路径，222行路径更改至所需测试图片路径，点击运行。 2、测试.onnx模型文件 1.在pycharm里打开下载的yolov5环境，在根目录打开 export.py 文件，修改默认输出模型类型为onnx，选择best_1.pt输入模型，点击运行。 2.在根目录找到detect_onnx.py文件，修改代码221行默认路径至模型路径，222行路径更改至所需测试图片路径，点击运行。

  • 郁郁苍苍---基于SpringBoot的多人社区项目.zip

    基于springboot的java毕业&课程设计

  • 华为FusionAccess桌面云解决方案基于华为FsionCompute云平台的一款虚拟化桌面应用

    华为桌面云解决方案 桌面云架构VDI和IDV VDI：虚拟桌面架构。特点是计算和数据都在云端，集中管理，集中运行。 IDV：智能桌面虚拟化。特点是镜像集中管理，计算和数据还是在终端，集中管理，分散运行。 （从方案的主推厂商看， 业界华为、思杰、Vmware（IDC国内桌面云市场份额排名前三）都主推VDI，目前推IDV架构的只有锐捷、噢易等少数国内厂商）

  • 一个基于SpringBoot+Editor.md的 API接口文档.zip

    基于springboot的java毕业&课程设计

  • 基于OpenCV的交通路口红绿灯控制系统设计 python毕业设计-源码+全部数据+使用文档（高分项目）.zip

    基于OpenCV的交通路口红绿灯控制系统设计 python毕业设计-源码+全部数据+使用文档（高分项目）.zip本资源中的源码都是经过本地编译过可运行的，评审分达到95分以上。资源项目的难度比较适中，内容都是经过助教老师审定过的能够满足学习、使用需求，如果有需要的话可以放心下载使用。 【备注】 1、该项目是个人高分毕业设计项目源码，已获导师指导认可通过，答辩评审分达到95分 2、该资源内项目代码都经过测试运行成功，功能ok的情况下才上传的，请放心下载使用！ 3、本项目适合计算机相关专业(如软件工程、计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载使用，也可作为毕业设计、课程设计、作业、项目初期立项演示等，当然也适合小白学习进阶。 4、如果基础还行，可以在此代码基础上进行修改，以实现其他功能，也可直接用于毕设、课设、作业等。 基于OpenCV的交通路口红绿灯控制系统设计 python毕业设计-源码+全部数据+使用文档（高分项目）.zip基于OpenCV的交通路口红绿灯控制系统设计 python毕业设计-源码+全部数据+使用文档（高分项目）.zip基于Op

  • 课设毕设基于SSM的知识产权管理系统源码可运行.zip

    课设毕设基于SSM的知识产权管理系统源码可运行.zip

  • 基于卷积神经网络的人脸识别.zip

    卷积神经网络（Convolutional Neural Networks, CNNs 或 ConvNets）是一类深度神经网络，特别擅长处理图像相关的机器学习和深度学习任务。它们的名称来源于网络中使用了一种叫做卷积的数学运算。以下是卷积神经网络的一些关键组件和特性： 卷积层（Convolutional Layer）： 卷积层是CNN的核心组件。它们通过一组可学习的滤波器（或称为卷积核、卷积器）在输入图像（或上一层的输出特征图）上滑动来工作。 滤波器和图像之间的卷积操作生成输出特征图，该特征图反映了滤波器所捕捉的局部图像特性（如边缘、角点等）。 通过使用多个滤波器，卷积层可以提取输入图像中的多种特征。 激活函数（Activation Function）： 在卷积操作之后，通常会应用一个激活函数（如ReLU、Sigmoid或tanh）来增加网络的非线性。 池化层（Pooling Layer）： 池化层通常位于卷积层之后，用于降低特征图的维度（空间尺寸），减少计算量和参数数量，同时保持特征的空间层次结构。 常见的池化操作包括最大池化（Max Pooling）和平均池化（Average Pooling）。 全连接层（Fully Connected Layer）： 在CNN的末端，通常会有几层全连接层（也称为密集层或线性层）。这些层中的每个神经元都与前一层的所有神经元连接。 全连接层通常用于对提取的特征进行分类或回归。 训练过程： CNN的训练过程与其他深度学习模型类似，通过反向传播算法和梯度下降（或其变种）来优化网络参数（如滤波器权重和偏置）。 训练数据通常被分为多个批次（mini-batches），并在每个批次上迭代更新网络参数。 应用： CNN在计算机视觉领域有着广泛的应用，包括图像分类、目标检测、图像分割、人脸识别等。 它们也已被扩展到处理其他类型的数据，如文本（通过卷积一维序列）和音频（通过卷积时间序列）。 随着深度学习技术的发展，卷积神经网络的结构和设计也在不断演变，出现了许多新的变体和改进，如残差网络（ResNet）、深度卷积生成对抗网络（DCGAN）等。

  • 基于springboot-mqtt的温度、湿度、六氟化硫浓度实时监控系统.zip

    基于springboot的java毕业&课程设计

  • 房地产企业财务风险的成因与防范对策-以万科集团为例.docx

    房地产企业财务风险的成因与防范对策-以万科集团为例.docx

  • 基于SpringBoot框架的中小企业完全开源的ERP.zip

    基于springboot的java毕业&课程设计

  • 基于springboot的动漫弹幕网站.zip

    基于springboot的java毕业&课程设计

Global site tag (gtag.js) - Google Analytics