团队里的妹子让阿粉跟她说说怎样写出好的代码

简介: 昨天,团队里的妹子很突然地就让阿粉跟她说说怎么才能写出一手好的代码阿粉本着负责任的态度,专门写了一篇文章出来,妹子嘛,就是要宠的嘛

写好注释

写代码这件事情,大概就是一时编程一时爽,过后调试火葬场

阿粉有过一次经历,就是当时开发任务紧,把功能实现之后就完事儿了,也没有好好写注释。结果过了两三个月之后,那个功能因为需求变动出 bug 了,出了 bug 就去解决呗

但是!!!因为阿粉没有写注释,当时的实现逻辑,为什么这样写全忘了,所以相当于又重头捋了一遍逻辑,那个味道,真是酸爽

所以阿粉要把这个建议放在第一个!

写注释的时候,如果逻辑比较复杂,可以先写一下大体思路,然后下面具体实现时再详细写,比如阿粉曾经写过的代码(做了脱敏处理,大家不要太较真啦,重点是阿粉写的注释


/**
     * 进行 XX 操作时调用此方法,用来向数据库插入数据
     * @param saveModel 要插入的数据
     * @return 是否保存成功
     * 
     * @author a'fen
     * @date 2020-10-17 23:50:45
     */
    public Boolean isSaveSuccess(SaveModel saveModel) {
        /*
            整体思路:
                1 接收传入的所有 id/name 的信息
                2 插入相关信息
                    2.1 XX 信息插入成功之后,再去 YY 表进行相关信息插入
                3 对 YY 表进行插入时,先判断是否有相关信息,如果有则进行更新,如果没有则直接插入
                4 是否添加 AA ,如果业务上配置了 AA ,则需要将相关内容更新到 ZZ 表中
                    注: 在 BB 界面点击下一步时,已经将相关信息插入到了 ZZ 表中
                            所以在这里只做更新即可
         */
   // 1 接收传入的所有 id/name 的信息
   // 创建 xxList 用来接收所有的 id/name 的信息
   List<XXModel> xxList = new ArrayList<>();
   // 对传入的信息按照 id 进行排序,方便接下来的操作
   saveModel.getIdList().stream.collect(Collectors.groupingBy(SaveModel::getId))
                .forEach((String mapKey, List<SaveModel> save) -> {
                    xxList.addAll(save);
                });
  // 2 插入相关信息
  // 循环 xxList
  for (XXModel model : xxList) {
   // 向 XX 表插入信息
   实现代码
   // 2.1 插入成功,去 YY 表做相关信息插入
   实现代码
  }
  // 3 对 YY 表进行插入时,先判断是否有相关信息,如果有则进行更新,如果没有则直接插入
  实现代码
  // 4 是否添加 AA ,如果业务上配置了 AA ,则需要将相关内容更新到 ZZ 表中
  实现代码
    }

在写代码之前,先想想可能的应用场景

有时候拿到需求之后,如果着急去做,后期可能会耗费不少的精力

阿粉曾经做过一个业务,类似用户充值的场景,当时阿粉拿到这个需求之后,就想着不就是充值钱嘛,那就定义一个 Integer 类型不就完了,然后一顿操作猛如虎,上线之后也没啥问题

结果有一次公司运营和其他一些第三方合作,用的就是充值这个接口,然后因为运营大批量的持续充值,直接超出了 Integer 的允许范围,导致整条业务线都没办法跑通

然后排查问题排查到最后,发现是阿粉造成的,而且还是因为一个数据类型引发的...阿粉当时真的是想钻到地下

代码是写给人看的,所以让自己的代码干净整洁一些

代码是写给人看的,不是写给机器看的。你想嘛,如果想要让机器看,直接写 0110001 这种编码方式不香吗!毕竟机器它只认 0 或者 1

所以代码是写给人看的,那么写代码的时候就让它干净整洁一些

比如:该缩进的缩进,该空一行的就空一行,比如下面这样:

public static void sleep(long millis, int nanos)
    throws InterruptedException {
        if (millis < 0) {
            throw new IllegalArgumentException("timeout value is negative");
        }
        if (nanos < 0 || nanos > 999999) {
            throw new IllegalArgumentException(
                                "nanosecond timeout value out of range");
        }
        if (nanos >= 500000 || (nanos != 0 && millis == 0)) {
            millis++;
        }
        sleep(millis);
    }

要缩进有缩进,该空一行就空一行,不用你们夸,我自己都觉得这代码写的,真是好!(Thread 源码谁敢说不好?!

没事儿就和阿粉多聊聊源码

其实想要写一手好的代码,最重要的就是要多看,自己多写

看什么呢?阿粉觉得看源码就够了。JDK 源码这么多人都在用,足以说明 JDK 源码的代码写的有多优秀

所以呢,没事儿就和阿粉多聊聊源码,没事儿就约约阿粉去图书馆一起研究研究源码,平时自己写代码的时候,多注意借鉴从源码中学到的实现思路,学到的编程技巧,日积月累下来肯定能在编程上有一个很好的提升


相关文章
|
敏捷开发 前端开发 开发者
想要成为软件开发中的王者,需要明白的 21 条准则
想要成为软件开发中的王者,需要明白的 21 条准则
100 0
|
8月前
|
算法
代码之美:从混乱到秩序的编程之旅
【7月更文挑战第14天】编程,一门将思维转化为电子指令的艺术。在这篇文章中,我将带你领略编程的美学,从最初的混沌编码到最终的逻辑严谨、运行高效的程序。我们将一同探索如何通过理解问题、选择合适的数据结构与算法、编写可读性强的代码以及不断重构来提升代码质量。这不仅是一个技术提升的过程,更是一次思维的升华。
|
9月前
|
设计模式 安全 测试技术
探索代码之美:从混乱到秩序
【5月更文挑战第32天】在编程的世界中,代码不仅是实现功能的工具,更是艺术的表达。本文将通过个人的技术感悟,探讨如何将混沌的代码转化为有序、高效且易于维护的程序。我们将一起深入理解编码的最佳实践,以及这些实践如何帮助我们构建更加健壮和优雅的软件系统。
|
10月前
|
监控 项目管理
项目如期完成是有多难?
【4月更文挑战第5天】项目如期完成是有多难?
71 6
项目如期完成是有多难?
|
算法 程序员 数据安全/隐私保护
2022 年终总结|怎样写出一篇还不错的文章
2022 年终总结|怎样写出一篇还不错的文章
89 0
|
Python
一日一技:你的代码是如何被炫技毁掉的
一日一技:你的代码是如何被炫技毁掉的
135 0
|
测试技术
软件测试好学吗 只要选对了学习方式,就并不难学
我们都知道,如今互联网IT行业,在国内可是非常吃香的,尤其是近些年随着软件的普及,人们对软件的要求也是越来越高,因此国内各大互联网企业,也开始大量招聘软件测试人员,但由于这个岗位在我国的发展时间并不长,人员需求也是供应不求的。
219 0
软件测试好学吗 只要选对了学习方式,就并不难学
|
存储 运维 Kubernetes
独家交付秘籍之招式拆解(第一回)
上一回说到经历种种交付难题的王小锤一行人,意外发现一本交付秘籍,打开了新世界。本次他们带着具体交付场景来到阿里云,与交付宗师阿莫探讨秘籍中的招式以及招式背后的秘密。
独家交付秘籍之招式拆解(第一回)
|
机器学习/深度学习 IDE Java
写出一手烂代码的 19 条准则!
「代码写得好」是对机器学习研究者及开发者最好的赞扬。其第一层意思是说,你的模型非常好,有自己的理解与修正;第二层意思是说代码的结构、命名规则、编写逻辑都非常优秀。
282 0
写出一手烂代码的 19 条准则!
|
Web App开发 XML 安全
技巧:你未必知道的IE8九大功能
微软为IE8赋予了不少新的功能,其中一个就是使得这些新功能的实现更加实用和简便。其中有很多优化功能,可能你没有完全留意到。不过,你完全不用去阅读那些详细的功能使用说明,我们在为你提供这些功能介绍的同时,还将补充一个微软都没有提到过的重要技巧——如何为IE8增添强大的广告过滤工具。
988 0

热门文章

最新文章