整洁的代码的原则

1. Model is everything

  models are  the heart of your app. If you have models separated from th rest of your application, maintaince will be much easier,regradless of how complicated your application becomes. Even for complicated applications, good model implementation can result in extremely expressive code.And to achieve that, start by making sure that your models do only what they meat to do ,and don‘t concern thenselves with what the app built around it does. Furthermore, it doesn‘t concern itself with what the underlying data storage layer is:does your app rely on an SQl database,or dose it store everything in text files.

  As we continue this article, you will realize how great code is a lot about separatiuon of concern.

  数据模型是一个应用的心脏,当数据模型与应用的其它模块分离开来的时候,应用的可维护性将变得容易。一个应用的数据模型应该保持单一职责原则,不应该考虑建立的数据模型上的其它模块,同时也不应该关注数据是如何存储的。 (MVC)

  面向对象编程的5个原则:

  <1>单一职责原则

    是指一个类或者模块应该有且只有一个去改变它的理由,这意味着一个类应该只有一项职责,并且该功能应该由这个类完全封装。 

  <2>开发封闭原则

    一个类应该对扩展是开放的,但是对修改是封闭的.意味着一个实体允许在不改变它的源代码的前提下变更它的行为

  <3>里氏替换原则

    里氏替换原则是对子类型的特别定义,该原则描述为:派生类对象能够替换其基类对象被使用。

  <4>接口隔离原则

    接口隔离原则推荐拆分庞大的接口成为更小更具体的接口,客户端不应该被被迫依赖它们不使用的方法。

  <5>依赖反转

    实体必须依靠抽象而不是具体的实现,它表示高层次的模块不应该依赖低层次的模块,它们都应该依赖于抽象。

  整洁的代码

  1.clean code is a consistent style of programming that makes your code easier to write,read ,and maintain.

  2.clean code is DRY (don‘t repeat yourself)

  3.clean code is predictable and testable

  4.clean code is self-commenting

  5.naming things

    1.Boolean variables,or functions that return a boolean value, should start with "is","has","should"

    2.Functions should be named for what they do,not how they do it.In other words ,don‘t expose details of the implementation in the name

  6.clean code follows proven design patterns and best practices

    1.use samll fuctions,each with a single responsibility.Ensure that each function does one job and does it well . that also will lead to better testability.

    2.Be on the lookout for leaky abstractions. In onther words, don‘t impose your internal requirements on consumers of your code.

    3.Follow stric linting rules. This will help you write clean , consistent code.

原文地址:https://www.cnblogs.com/wust-hy/p/10503580.html

时间: 2024-11-14 19:44:32

整洁的代码的原则的相关文章

【整洁之道】如何写出更整洁的代码(上)

如何写出更整洁的代码 代码整洁之道不是银弹,不会立竿见影的带来收益. 没有任何犀利的武功招式,只有一些我个人异常推崇的代码整洁之道的内功心法.它不会直接有效的提高你写代码的能力与速度,但是对于程序员的整个职业生涯必然会带来意想不到的好处. 如果你还是一个在校学生,或者是刚工作没多久的"菜鸟",那么很有必要接触一些这方面的知识的.很显然,它会帮助你更快的适应企业级开发的要求. 1. 为什么需要代码更整洁? 在考虑代码整洁的时候,我们需要明确的一个前提是,这里不讨论代码的对错. 关于什么是

软件开发实践:如何编写整洁的代码

最近在工作中, 经常会维护一些已经存在的代码,经常Review别人的代码,也经常请别人Review代码. 感觉Review代码真是一个很累人的工作.感谢那些为我们Review代码的同事. 很多时候,感觉Review的效果并不好,难以深入下去. 如何Review好代码,当前还没有太好的思路,结对编程是一个方法,但是自己没有实践过,仅仅在思考的层面上,所以也难以有发言权. 但是,如何方便别人Review,如何提高自己的代码质量,倒是总结了一些内容,本我大打算主要站在C/C++开发人员的角度写一下自己

代码整洁 vs 代码肮脏

写出整洁的代码,是每个程序员的追求.<clean code>指出,要想写出好的代码,首先得知道什么是肮脏代码.什么是整洁代码:然后通过大量的刻意练习,才能真正写出整洁的代码. WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了我们是糟糕代码的受害者.国内有一个更适合的词汇:屎山,虽然不是很文雅但是更加客观,程序员既是受害者也是加害者. 对于什么是整洁的代码,书中给出了大师们的总结: Bjarne Stroustrup:优雅且高效:直截

代码复用原则:合理使用类组合和类继承

继承和组合都可以达到代码复用的目的,但是组合比继承更具灵活性.组合是通过引用已有类(一般为抽象类)或接口来实现复用的组合在运行时通过多态可以动态替换被组合的对象.继承是通过以子类继承父类方式来使父类的非私有成员可以被其子类使用.继承在类编译时就确定了继承来的方法和 属性,无法在运行时动态改变从父类继承来的方法.如果继承得来的某个方法在子类中不适用,这时就需要重写该方 法.而这样又很有可能违反LSP设计原则.如果父类非私有成员发生了改变那么继承他的子类也不得不发生改变父类改 变.所以这种复用方式仅

代码重构原则

1. 总则 总则规定了一些大体原则,必须要作的.最需要注意的事项.也是面向目前我们的代码中亟需解决的一些问题: (1)头文件.源文件布局混乱,直接影响编译效率 (2)有编程规范,但遵守的很差 (3)过长函数 (4)大量重复代码 1.1 源文件 源文件原则: ● 函数行数尽量不要超过50行,超过50行的目前阶段并非严格禁止,但需要说明理由 ● 源文件长度尽量不要超过500行, 不同子功能.子模块的代码不要放在一个源文件中:理论上源文件分的越细越好.保证同一源文件中的代码“强内聚”. ● 无特殊情况

NASA的10条代码编写原则

NASA的10条代码编写原则 作者: Gerard J. Holzmann 来源: InfoQ 原文链接 英文原文:NASA's 10 Coding Rules for Writing Safety Critical Program 译/ 大愚若智 image 本文将介绍由 NASA 喷气推进实验室首席科学家 Gerard J. Holzmann 所提出的,侧重于安全参数的10条代码编写原则 美国宇航局(National Aeronautics and Space Administration,

高效整洁CSS代码原则(上)

CSS学起来并不难,但在大型项目中,就变得难以管理,特别是不同的人在CSS书写风格上稍有不同,团队上就更加难以沟通,为此总结了一些如何实现高效整洁的CSS代码原则: 1. 使用Reset但并非全局Reset不同浏览器元素的默认属性有所不同,使用Reset可重置浏览器元素的一些默认属性,以达到浏览器的兼容.但需要注意的是,请不要使用全局Reset: *{ margin:0; padding:0; } 这不仅仅因为它是缓慢和低效率的方法,而且还会导致一些不必要的元素也重置了外边距和内边距.在此建议参

高效整洁CSS代码原则 (下)

6. 适当的代码注释 代码注释可以让别人更容易读懂你的代码,且合理的组织代码注释,可使得结构更加清晰.你可以选择做的样式表的开始添加目录: /*------------------------------------ 1. Reset 2. Header 3. Content 4. SideBar 5. Footer ----------------------------------- */ 如此你代码的结构就一目了然,你可以容易的查找和修改代码. 而对于代码的主内容,也应适当的加以划分,甚至

设计模式-代码设计原则

遵循原则的目的 代码复用.增加可维护性. 具体原则 1,开闭原则.开放扩展,扩展用子类或抽象类接口在实现类.关闭修改. 开闭原则具有理想主义的色彩,它是面向对象设计的终极目标.其他几条,则可以看做是开闭原则的实现方法. 设计模式就是实现了这些原则,从而达到了代码复用.增加可维护性的目的. 扩展时用抽象类或接口定义扩展的范围,引用对象也用抽象类和接口,抽象层尽量保持稳定 2,里氏代换原则.即为了实现开闭,使用继承.如果调用的是父类的话,那么换成子类也完全可以运行. 3,依赖倒转原则. 简单的说就是