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

Z时代
2024-01-10
分类：技术分享

昨天团队里的妹子很突然地就让阿粉跟她说说怎么才能写出一手好的代码

阿粉本着负责任的态度，专门写了一篇文章出来，妹子嘛，就是要宠的嘛

写好注释

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

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

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

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

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

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

publicBooleanisSave(SaveModelsaveModel){
/*
整体思路:
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=newArrayList<>();
// 对传入的信息按照 id 进行排序,方便接下来的操作
saveModel.getIdList().stream.collect(Collectors.groupingBy(SaveModel::getId))
.forEach((StringmapKey,List<SaveModel>save)->{
xxList.addAll(save);
});
// 2 插入相关信息
// 循环 xxList
for(XXModelmodel:xxList){
// 向 XX 表插入信息
实现代码
// 2.1 插入成功,去 YY 表做相关信息插入
实现代码
}
// 3 对 YY 表进行插入时,先判断是否有相关信息,如果有则进行更新,如果没有则直接插入
实现代码
// 4 是否添加 AA ,如果业务上配置了 AA ,则需要将相关内容更新到 ZZ 表中
实现代码
}

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

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

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

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

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

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

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

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

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

比如：该缩进的缩进，该空一行的就空一行，比如下面这样：

publicstaticvoidsleep(longmillis,intnanos)
throwsInterruptedException{
if(millis<0){
thrownewIllegalArgumentException("timeout value is negative");
}
if(nanos<0||nanos>999999){
thrownewIllegalArgumentException(
"nanosecond timeout value out of range");
}
if(nanos>=500000||(nanos!=0&&millis==0)){
millis++;
}
sleep(millis);
}