美文网首页
编写可读代码的艺术 1

编写可读代码的艺术 1

作者: DZQANN | 来源:发表于2022-03-14 21:42 被阅读0次

代码应该容易理解

这个是我上一轮写Story的一个例子

我们有一些场景也要使用类似pivot view的样子,但是和传统的pivot view也有很多的区别,这时候就需要手动group by很多vo上面的字段

public class TariffVo {
    private String dim1;
    private String dim2;
    private String dim3;
    private String ctnSize;
    private String ctnType;
    private String unitPrice;
    private Map<String, String> sizeTypeWithPrice = new HashMap<>();
}

这里就需要group by dim1,2,3。所以说要重写hashCode和equals方法

以前我会过于想去遵循那个叫"return first"?规则,equals会写成下面这个样子

public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        TariffVo tariffVo = (TariffVo) o;
        if (!Objects.equals(dim1, tariffVo.dim1)) {
            return false;
        }
        ....
}

直到上次我用了IDEA的自带重写equals方法

public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        TariffVo tariffVo = (TariffVo) o;
        return Objects.equals(dim1, tariffVo.dim1)
                && Objects.equals(dim2, tariffVo.dim2)
                && Objects.equals(dim3, tariffVo.dim3);
}

这个地方的优势在于,它没有"非"逻辑,让人一下就看懂了,就是这几个字段都要一样。当然我一开始的写法也很简单,只不过理解上稍微复杂了一点

命名

这是一件非常考验英语的事情,之前我们讨论过"合并"应该怎么翻译。我觉得代码中应该主要用的是merge和combine。merge更像是两个比较复杂的结构混合在一起了,比如git。Java里我觉得Map更像Merge,好像Java8里Map就多了merge方法。combine就是两串东西拼成了一串,就是List了。

example 1

书中有一个例子我觉得可以拿来讨论一下,它说一以下词汇都是make的可以替代词:

  • create
  • build
  • generate
  • compose
  • new

这里面除了new我都用过,而且非常不固定,主要看第一个想起来的单词是哪个。现在仔细想想compose更像是一个有参数的?create build generate就完全想不出来有什么区别了

example 2

我之前因为需要,写了一个ListUtil.splitList方法,两个参数: List<T> inputList, int eachGroupCount

后来我看别人写代码发现google库提供了Lists.partition方法,一样的功能。但是我还是觉得,split更好一点,jdk的String官方就是split

example 3

书中还提到了迭代器的命名。我也是之前刚刚看了一段别人写的代码,它就是for i for j。同时有i j的时候,虽然是比较简单的逻辑,但是分清i和j还是让我眼睛难受了一阵的。

example 4

Java里面,Date的getTime就是一个很让人困惑的命名,是不是可以叫getMilliSeconds?

之前自己写代码的时候也很不解,LocalDate和LocalDateTime的format函数的参数都是DateTimeFormatter。当我使用LocalDate的时候就有点傻了,有点不明白为什么还要传DateTime

相关文章

  • 代码可读性

    这是一篇结合项目代码与《编写可读艺术的代码》一书结合的读书笔记 代码应当易于理解 《编写可读艺术的代码》这本书告诉...

  • 编写可读代码的艺术

    【代码质量】: 代码行数、时间复杂度、内存消耗,准确率; 《clean code》:在代码阅读过程中人们说脏话的频...

  • 编写可读代码的艺术

    来源 《编写可读代码的艺术》 第2章 把信息装到名字里 1. 选择专业名词 找到更有表现力的词 2. 避免泛泛的名...

  • 编写可读代码的艺术

    以下是书里文字的引用与整理 前言 可读性基本定理:代码的写法应当使别人理解它所需的时间最小化。 一、表面层次的改进...

  • 《编写可读代码的艺术》

    1.调整心态认识到编写可读代码的必要性。在编写可拓展代码,可用代码和可读代码之间的优先级,编写可读代码较高;克服思...

  • 编写可读代码的艺术

    1.写在前面 最近花了一个周的零星时间,看了《编写可读代码艺术》,收获颇多。虽然平时也经常使用书中提到的一些方法编...

  • 编写可读代码的艺术

    "阅读本文大约需要 5 分钟" 很多程序员在学习一门新的编程语言时,会先学习基础的语法和自带的基础库,稍加熟练后便...

  • 编写可读代码的艺术

    先放大佬的视频教学地址:https://github.com/biezhi/write-readable-code...

  • 编写可读艺术的代码

    前言 编写代码,实质是在梳理逻辑,为了完善整个逻辑流程,我们借用编程语言的变量、函数、流程控制、循环、注释、方法等...

  • 『No24: 编写可读代码的艺术(1)』

    大家好,我叫谢伟,是一名程序员。 除了本职工作,还有点幻灯片演示设计的爱好。随着编写代码的增多,制作的的幻灯片越来...

网友评论

      本文标题:编写可读代码的艺术 1

      本文链接:https://www.haomeiwen.com/subject/mxfudrtx.html