代码整洁之道笔记(二)

本文是《代码整洁之道》笔记的第二部分,主要讨论代码的垂直和水平格式规范,包括文件长度、方法排列、空行使用以及水平宽度的控制。此外,还涉及对象和数据结构的设计原则,如通过getter/setter保护内部实现,遵循得墨忒定律以保持模块间的低耦合。
摘要由CSDN通过智能技术生成

一、格式

(一)、垂直格式

  1. 尽量用200~500行为单个文件。

  2. 源码应该像报纸一样:上面是大纲,下面是细节。最顶部应该是高层次概念和算法,细节应该依次向下展开,放在我们代码里意思就是:public方法应该放在上面,private方法应该放在下面。应该是一个总分结构。

  3. 概念上垂直方向的区隔
    代码中是需要一些空行的,方法间必须要有空行,方法中:两段功能不同的代码中也需要空行,以区别不同的代码段,但这个尺度需要掌握好,空行特别多时也会影响阅读。所以若干很短比如只有一行的代码段就无需再空行了
    String name = “A”;
    Int age = 10;
    String sex = “男”;

    User user = new User();
    User.setName(name);
    User.setAge(age);
    User.setSex(Sex);

    Mapper.insertUser(user);

  4. 垂直方向上的靠近
    与上面相反,一些功能或概念相似的代码段是应该放在一起的,比如我上面的代码中把变量初始化放在一起,new一个对象的过程放在一起。这样很容易知道它们是相似的。在类中也应该是这样,私有变量放在一起,公有变量放在一起。

  5. 垂直距离
    关系密切的概念应该相互靠近,条件是在同一个文件中。其实并不应该把关系密切的概念放在不同文件,所以应该避免使用protexted变量。
    a. 变量的声明应该靠近其使用位置,比如我们写循环的控制变量一般就放在循环上面。
    b. 实体

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值