写一些友好的代码(上),对人友好

写一些友好的代码(上),对人友好

这是一篇关于程序员的一个最基本条件的文章——编码。也是我学习虚拟机之后最大感触的一些内容。

作者:小米(lvgocc)

公众号:星尘的一个朋友

前言

正文之前,还是想强调一下今天关于编码的分享,要 区别 “好” 与 “友好”。毕竟还是有差距。就像好的论文、好的书籍,专业性很强,内容质量很高。但它并不一定是友好的,就像现在大多数人在写作都在追求 “通俗易懂”,这就是友好。他们这些人负责把难理解的内容消化掉然后换一种方式来表述出来,同时尽可能的不丢失原来的“本色”。这样的内容就是友好的,同时它也一定是好的。(这个一定,可以通过反证法得出)

正文

今天分享的主题是 “对人友好的代码”。希望看过文章的朋友们,能够有所收获。

关于编码,我想这应该是程序员最熟悉不过的事儿了。也是作为一个程序员最基本的职能了,而恰恰是最常做的事,最容易产生自信。而这种自信,有时便会成为理所应当的坏习惯。

对人友好

对人友好的代码怎么理解?

在很多时候,比如公司内部代码走查、阅读开源代码,甚至看自己写过的代码。都会有一种冲动,什么冲动?重构的冲动!

我想,有这种想法的人肯定不止我一个。首先我很肯定,有这种想法的人,都是想要写出更加优秀的代码的人。但事实上呢?是不是很多时候是因为别人的代码不如你意呢?又或者只是单纯的觉得这样写就是不合适,原因不知道?。不管怎么说,我还是认为有这种想法的开发人员是很好的。

vant 演示中 dialog 的截图 | 写一些友好的代码 作者:小米 公众号:星尘的一个朋友

好的代码?友好的代码?

我要写一手好的代码!这个问题我也经常在敲代码的时候在想。可事实你想写出好的代码并没那么容易,既然我写不出来好的代码,那我能不能写出一些对人友好的代码? 我想这应该就是我能写出来好的代码的第一步吧。所以我从写出一些友好的代码下手了。

我认为对人友好的代码

对人友好的代码实在是太多了,我列一些自己随便想到的一些,算是抛砖引玉,希望能够和更多人产生友好的代码共鸣。

首先一定要能读

最基本的对人友好,就是代码不要看起来很脏,给人一种不能够阅读的感觉。下面举个不可阅读的例子

不可阅读代码 | 写出一些友好的代码 作者:小米 公众号:星尘的一个朋友

这种代码我亲身经历在线上版本见到过

对人友好的代码基本条件,能读。

其次,不要让人误会

让人误会的代码 | 写出一些友好的代码 作者:小米 公众号:星尘的一个朋友

仔细看,这里的 ① 和 ② 是不在一个条件中的。同事因为这种写法,出过生产问题。当时他说代码没问题叫我帮他看看。说实话,当时挺懵的。

三,不要做复杂分支的判断鬼才

例子为最基本示意例子,实际情况判断中或更为复杂

复杂 的逻辑分支判断这一点,我想应该是最常见。因为前面两个完全可以通过 IDE 帮你规避,不过这一点,稍不留意,就会变得有点放肆了。

        // A B C 条件同时满足
        if (A && B && C) {}
        
        if (!A || !B || !C) {}

在开发组内我一直强调的就是,在 复杂 逻辑判断要简单而且使用正向思维。就是多用与,少用或非,注意是少用,不是不允许用。能用与就用与,能不用非就不用非。因为这更能提高理解速度。特别是在一些 复杂 的逻辑判断分支中。

同时,如果分支内容判断条件过多时,建议拆解。比如

        if ((A != AA || A != AB ) && B && C) {}

可替换为

        boolean a = A != AA || A != AB;
        if (a && B && C) {}

关于 复杂 分支的判断的关键点就在于理解,所谓对人友好,就是让人很快就能看明白你代码的意思。这就需要根据实际的逻辑语境做一些合理的判断写法了。

下面随便列了一个逻辑判断的代码,简单感受一下。

        
        int age = 0;
        // 0 male 1 female 2 demale
        int gender = 0;
        int height = 0;
        int weight = 0;

        // 筛选出 年龄大于 18 小于 60 , 非人妖, 身高 140 以下, 体重80 以下的人
        if (age > 18 && age < 60 && gender != 2 && height > 140 && weight > 80) {
            // 合格人
        }
        
        if (!((age < 18 || age > 60) || gender == 2 || height < 140 || weight < 80)) {
            // 合格人
        }

        boolean ageFlag = age > 18 && age < 60;
        boolean genderFlag = gender != 2;
        boolean heightFlag = height > 140;
        boolean weightFlag = weight < 80;
        if (ageFlag && genderFlag && heightFlag && weightFlag) {
            // 合格人 
        }
            

四,迷惑行为少一点

前方迷惑代码高能预警,以下代码为项目真实代码。请不要对号入座!请不要对号入座!请不要对号入座!

存了个寂寞

存了个寂寞|写出一些友好的代码 作者:小米 公众号:星尘的一个朋友

不清楚它要做什么,思来想去,应该只是来浪费了我代码审查的时间,怕我没事做,为我增加工作量。

任性换行

随性换行与日志框架技术不了解|写出一些友好的代码 作者:小米 公众号:星尘的一个朋友

这换行符我说了算,我觉得它该换行了。免疫 IDE 警告。

截取寂寞

截取寂寞|写出一些友好的代码 作者:小米 公众号:星尘的一个朋友

免疫 IDE 警告+1。

异常自己也没想到会这样

对于异常,我最了解|写出一些友好的代码 作者:小米 公众号:星尘的一个朋友

如果你看不懂这段操作,请关注我。一起讨论一下这件关于异常处理怎么写能写飞这件事。还有,到底还要怎么样才能会用日志框架?

谢大国的媳妇,香秀

彪悍的人生,不需要太多解释|写出一些友好的代码 作者:小米 公众号:星尘的一个朋友

免疫 IDE 警告+1。

友好的代码

回到我们的主题,对人友好的代码,还是上面那句话,对人友好的代码实在是太多了!我想,任何一个程序员都可以写出对人友好的代码,就看你想不想去写。试想你自己写的代码,过了几个月回去看,心里喷了半天结果一看作者是自己。这就很尴尬了。对人友好的代码它可能并不一定是最好的代码,但最起码是认真写的代码,这将会是写出好代码的第一步,希望大家都能迈出去。

关于编码,我想这应该是程序员最熟悉不过的事儿了。也是作为一个程序员最基本的职能了,而恰恰是最常做的事,最容易产生自信。而这种自信,有时便会成为理所应当的坏习惯。

其实关于对人友好的代码并不是技术上的话题,我觉得这更像是社交上的话题,程序员可能会习惯通过你的代码来了解你这个人。至少我有这样的一点小习惯。见码如见人。

写在最后

最后用 vant demo 中的话结个尾吧:代码是给人看的,附带可以在机器上运行。

正文完


欢迎关注我,微信搜索 lvgocc 或者 星尘的一个朋友,我是小米,下一篇分享 【写一些友好的代码(下),对机器友好】。谈谈如何面向虚拟机编程,写出对机器友好的代码。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值