@TOC


前言

在工作中学习中,如同学算法学四大基础夯实基础一样,咱们要不断考虑的是如何将代码写的更健壮,这个很重要,那就开始学起吧,与诸君共勉。

干净的代码

1.干净的代码,不是指代码是否有效,而是指的是易于阅读和理解的代码

  • 我们平时工作中会花很多时间去阅读代码、理解代码,因为我们必须要回到过去写的代码中来修复一个bug或者定制功能。所以阅读代码和理解代码会极大程度上影响咱们的生产力、效率。
  • Such as:
    • Shouble be readable and meaningful
    • Shouble be reduce cognitive load
    • Shouble be concise and “to the point”
    • Shouble be fun to write and to maintain

2.写干净代码的方法不止一种

  • 需要注意的一点就是,专注于代码中任何命名的地方【变量、方法或者叫函数、常数、类等】
    • 统一命名规范和风格
    • 命名有意义, 让看的人一看就知道你这个命名的意思
      • 变量的命名,应该能够表达出变量中存的什么
      • 方法或函数的命名,应该能够表达出这个方法或函数要做什么,让看的人不必每次都要查看这个方法或函数内部的代码。例子如下:你会写bad那样,还是good那样呢?
        1
        2
        3
        4
        5
        6
        7
        8
        9
        10
        11
        12
        13
        14
        15
        16
        17
        18
        //我们想要存储关于用户信息的文件或者数据到库里,那么这样写

        //bad
        Xxx temp = new XXX(...);\
        temp.process();

        if(login)
        {
        ...
        }
        //good
        Xxx user = new XXX(...);\
        user.save();

        if(isLoggedIn)
        {
        ...
        }
        • 如果你写temp、process、login,可能看的人会问,你写这个temp是什么意思呢?你又用temp调用这个process,是准备干什么呢?,然后判断条件中又是以什么作为判断依据呢?你看,其实很简单的代码,但是你让阅读者不得不去看更多代码的细节,才能明白你的意思。下面逐个来说命名那些事

巨人的肩膀