很多代码质量的文章中提到了代码腐烂, 但此文很形象,收集。
作者:Stack Huang
很多团队都有这个问题,一个项目的代码本来开始设计得好好的,一段时间以后,代码就会变得难以理解,难以维护,难以修改。为什么?我一直在思考这个问题。
让我们先看一个人的情况。
1.程序员的成长
新手的代码
新手的代码没有经验,基本不考虑代码设计,代码规模稍稍大一点则自己就乱了。
进阶者的代码
小规模的时候
大规模的时候
进阶者已经知道如何设计代码,懂得代码规则,但一般局限于一个模块。规模一大,模块间的调用就会比较混乱,难以维护。
有经验者的代码
有经验者的代码,模块内部代码整洁,模块之间层次清晰,有设计模式,有成熟的体系。可以保持长期的代码整洁。
那么一个团队里面会出现什么情况呢?似乎,我们只要让一堆有经验的人来开发,那么代码必然不会出什么问题。可惜,事实不是这样。
2.背景
代码风格的多样性
有这样的。
也有这样的
放眼一看,会发现不同的代码风格,不同的设计思想,不同的设计理念。每个程序员都有自己的代码个性。
团队层次的差异
一个团队内部有新人,有熟手,有牛人。一个设计好的架构可能会变坏。
3.原因
风格的融合
当程序员A和程序员B在一起的时候,会有如下变化
原本整洁的代码变得不整洁了。
进度的压力
进度导致了“飞线”的产生,未经设计的代码在时间的借口下产生了。
多个人修改一个模块
4.本质
所有代码腐烂问题的本质是沟通问题。其表现又都可以统一为修改别人的代码。
当一个程序员在没有沟通的情况下,修改另一个程序员的模块的代码的时候,他可能不理解此模块的设计思路,代码结构,逻辑结构,于是按自己的想法去修改,虽然看起来解决了眼前的问题。但是留下了一个不稳定因素。此因素可以通过重构来解决。但是,大家都非常的“忙”,谁也没有空时间去Review代码,去沟通我改了你的哪里的代码。所以不稳定的因素越来越多,导致了代码的腐烂。
最快腐烂的代码,一定是很多人在修改的代码,相反,长期由一个人来维护的代码,就不会那么容易腐烂。因为一个人不存在沟通的问题,他修改代码的时候,明确的知道自己应该怎样去修改,怎样让代码更整洁。
5.解决
就一个办法,多沟通。
当你工作的时候需要修改别人的代码的时候,应该先找这个人沟通。说清楚需要改动的逻辑,然后尽量让他来修改。这样可以保证一块代码是由一个人维护,这样成本最少。
如果此人真的太忙,没有时间,那么你必须说明你的计划,让他做一个建议,最好能让他给你讲讲此模块的设计思路,代码设计,逻辑设计,现在的问题,以后的计划。保证你修改的代码都是合理的。
最理想的状态就是整个团队的思想是高度统一的,N个人可以像一个人那样去工作。这个需要团队长期的磨合。
你可以会想到,我们制定一个规范不就可以了么?纸面上的规范通常是不起作用的,成功团队的规范是在整个团队达到一个很高的水平以后总结的经验。与其说执行规范,不如说是学习经验。MFC的代码像是由一个人写出来的,Office所有产品都像是一个人做出来的。这就是高度的统一。我们把微软的规范搬过来,不一定就有效果。
代码的腐烂都是由于没有深入理解的情况下修改别人的代码导致的。
总结一下:
-
解决的方法就是任何修改之前确保经过深入的沟通。
-
简单的规则是一个模块仅允许一个人维护。
-
理想的状态是整个团队思想高度统一。
分享到:
相关推荐
力扣热题Python源代码 题目994. 腐烂的橘子 在给定的 m x n 网格 grid 中,每个单元格可以有以下三个值之一: 值 0 代表空单元格;值 1 代表新鲜橘子;值 2 代表腐烂的橘子。 每分钟,腐烂的橘子 周围 4 个方向上...
YOLOv8 腐烂水果识别项目代码 项目详细介绍请看链接: https://blog.csdn.net/qq_53332949/article/details/143932432 数据集详细介绍请看:https://blog.csdn.net/qq_53332949/article/details/140979409 数据集...
YOLOv8 苹果腐烂识别项目代码 项目详细介绍请看链接: https://blog.csdn.net/qq_53332949/article/details/143591924 数据集详细介绍请看:https://blog.csdn.net/qq_53332949/article/details/140628787 按文件中...
为了方便观察掩膜,提供了可视化代码。 【具体的标签类别可以在classes txt文本中查看】 数据集介绍:分为训练集、测试集 训练集:images图片目录+masks模板目录,2958张图片和2958个对应的mask图片 测试集:images...
在收割白菜的例子中,可能涉及到如何按顺序收割白菜以最大化收益,如先收割最大或最易腐烂的白菜。 2. **动态规划**:动态规划是处理具有重叠子问题和最优子结构特征的问题的有效方法。在收割白菜场景下,可能要...
##### 1.4 防止架构腐烂 随着项目的迭代,如果不加以控制,可能会导致代码架构逐渐变得复杂且难以维护。定期进行代码评审可以帮助团队及时发现问题并调整方向。 ##### 1.5 知识分享 代码评审是一个极佳的知识共享...
shufflenet模型_CNN图像分类识别樱桃是否腐烂-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行网上...
mobilenet模型_CNN图像分类识别苹果是否腐烂-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行网上...
shufflenet模型_基于卷积神经网络识别橘子是否腐烂-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行...
alexnet模型_python语言pytorch框架训练识别芒果是否腐烂-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,...
resnet模型_图像分类算法对草莓是否腐烂识别-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行网上...
resnet模型_基于卷积神经网络识别葡萄是否腐烂-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行网上...
vgg模型_深度学习CNN训练识别胡萝卜是否腐烂-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行网上...
shufflenet模型_基于图像分类算法对洋葱是否腐烂识别-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可...
densenet模型_基于深度学习对菠萝是否腐烂识别-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行网上...
mobilenet模型_基于深度学习AI算法对西瓜是否腐烂识别-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可...
resnet模型_通过CNN卷积神经网络的猕猴桃是否腐烂识别-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可...
densenet模型_基于图像分类算法对香蕉是否腐烂识别-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行...
densenet模型_基于卷积神经网络识别火龙果是否腐烂-不含数据集图片-含逐行注释和说明文档 本代码是基于python pytorch环境安装的。 下载本代码后,有个环境安装的requirement.txt文本 如果有环境安装不会的,可自行...