每一座屎山代码背后，都藏着一堆熟读代码规范的研发
导读
韩寒在《他的国》中写道：“我们懂很多道理，却依然过不好这一生”，人们虽然知道很多道理，但并不一定能将这些道理应用到实际生活中。这种现象在生活中很常见，我们听了很多的成功学的道理，但实际上，成功和幸福不是仅仅靠这些道理就能实现的，需要不断地努力和实践，才能实现自己的目标。而在开发的过程中也会遇到类似的问题，明明熟读《代码整洁之道》，却依旧只能写低效代码，行业内经常调侃“一个优秀的程序员可以带动多人就业”，这些中间欠缺的是什么？如何快速落实？本文将从几个方面进行分析，欢迎阅读。
目录
1 时间压力
2 业务需求
3 自我驱动力
4 团队合作和沟通
5 技术债务
6 自动化工具和流程
7 反馈和改进机制
8 个人实施案例
01 时间压力
在开发的过程中，项目可能有紧迫的截止日期，需要在有限的时间内完成。这可能导致时间压力，同时在开发过程中，可能会遇到一些不可预见的延迟和问题，如技术难题、系统故障等，这会导致开发时间的压缩。使得开发者难以花费足够的时间来编写高质量的代码。
解决办法：
**▶︎合理规划和管理时间：**在项目开始之前，制定详细的项目计划和时间表，并合理分配各个任务的时间。确保给自己足够的时间来编写高质量的代码。
**▶︎优先级管理：**根据任务的重要性和紧急程度，合理设置任务的优先级。将时间和精力集中在最重要的任务上，确保其优先完成。
**▶︎寻求帮助和支持：**如果时间压力过大，可以向上级或团队领导寻求帮助和支持。他们可能会提供额外的资源或调整项目计划，以减轻开发者的压力。
**▶︎自我管理和调整：**开发者需要学会自我管理和调整，合理安排工作和休息时间。避免过度工作和疲劳，保持身心健康，提高工作效率。
**▶︎寻找时间优化的机会：**在开发过程中，寻找可以优化时间的机会。例如，使用代码模板、重用已有的代码、利用开源库等，可以减少开发时间。
02 业务需求变更
在软件开发过程中，业务需求可能没有被充分明确或者变化频繁。这可能导致开发者需要频繁修改代码，而没有足够的时间来重构和优化代码质量。
解决办法：
**▶︎加强需求分析和明确：**与客户或项目经理密切合作，确保需求被充分分析和明确。通过详细的需求文档、用户故事、原型等方式，减少需求模糊性，降低需求变更的频率。
**▶︎频繁沟通和反馈：**与客户或项目经理保持频繁的沟通和反馈。及时更新项目进展，让客户或项目经理了解开发进度和可能的影响。这样可以减少需求变更的频率，并及时调整开发计划。
**▶︎敏捷开发方法：**采用敏捷开发方法，如 Scrum 或 Kanban，可以更好地应对需求变更。通过迭代开发和短周期的发布，可以及时响应需求变更，并减少时间压力。
**▶︎需求变更管理：**建立良好的需求变更管理机制。对需求变更进行评估和优先级排序，确保只有真正重要和紧急的变更才会被接受，并及时更新开发计划。
**▶︎风险管理和缓冲时间：**在项目计划中，考虑到需求变更的风险，并为此留出一定的缓冲时间。这样可以应对可能的变更，减少时间压力。
03 自我驱动力
尽管开发者知道代码整洁和代码质量的重要性，但他们可能缺乏自我驱动力来主动提高自己的编码水平。他们可能更关注完成任务而忽略了代码质量。
解决办法：
**▶︎找到工作的意义和价值：**深入思考开发工作的意义和价值，明确自己的职业目标和发展方向。通过理解工作的重要性，能够激发自我驱动力去追求高质量的代码。
**▶︎设定明确的目标和计划：**制定明确的目标和计划，将开发过程分解为小的可管理的任务。通过逐步完成这些任务，逐渐提高代码质量，增强自我驱动力。
**▶︎增强自信心：**通过不断学习和提升自己的技术能力，增强自信心。参加培训、读书、参与开源项目等方式，能够提高自己的专业知识和技能，从而有信心写出高质量的代码。
04 团队合作和沟通
在一个团队中，如果没有共同的代码整洁标准和代码质量意识，开发者可能很难在项目中保持一致的代码质量。缺乏有效的沟通和合作也会影响代码整洁的实施。
解决办法：
**▶︎制定统一的代码整洁标准：**项目组应该制定统一的代码整洁标准，明确代码的命名规范、代码风格、注释规范等。可以参考行业的最佳实践和代码规范，如 Google 的编码规范、Clean Code 等。
**▶︎建立代码审查机制：**在项目中引入代码审查机制，通过对代码的检查和评审，及时发现和纠正代码质量问题。可以通过代码审查工具或人工的方式进行代码审查。
**▶︎建立知识分享和交流机制：**建立一个开放的知识分享和交流平台，让开发者可以互相学习和交流经验。可以组织技术分享会、团队建设活动等，促进开发者之间的合作和学习。
**▶︎奖励和认可优秀的代码质量：**对于在项目中表现出色的开发者，可以给予奖励和认可，激励他们保持高质量的代码。这可以是一种激励机制，促使开发者提高代码质量意识。
05 技术债务
在开发过程中，由于一些原因，开发者可能会采取一些权宜之计，暂时牺牲代码质量以满足需求。这些权宜之计可能导致技术债务的积累，随着时间的推移，代码变得越来越难以维护和改进。如下所示：
改进方法和思路：
**▶︎分阶段交付和迭代开发：**将项目分解为多个阶段，每个阶段都有明确的交付目标。通过迭代开发的方式，及时交付部分功能，减轻时间压力，避免牺牲代码质量。
**▶︎技术债务管理：**及时识别和记录技术债务，将其纳入项目的规划和管理中。在后续的开发过程中，逐步还清技术债务，提高代码质量。
**▶︎技术选型和技术评估：**在项目开始之前，进行充分的技术选型和技术评估，选择适合项目需求的技术栈。避免因技术选型不当导致后期维护困难。
**▶︎代码审查和重构：**定期进行代码审查，及时发现和纠正代码质量问题。在项目后期，可以考虑进行代码重构，改善代码的可读性、可维护性和可扩展性。
06 自动化工具和流程
缺乏自动化工具和流程可能使得代码整洁和代码质量的检查变得困难。开发者可能需要手动进行代码审查和测试，增加了工作量和错误的可能性。
解决办法：
**▶︎使用自动化工具：**选择适当的自动化工具来辅助代码整洁和代码质量的检查。例如，使用静态代码分析工具（如 SonarQube、ESLint、PMD 等）来检查代码规范和潜在的问题。使用单元测试框架（如 JUnit、pytest 等）来自动化测试代码。这些工具可以帮助开发者减少手动工作，提高代码质量。
**▶︎持续集成和持续交付：**引入持续集成和持续交付的流程，自动化构建、测试和部署过程。通过自动化的流程，可以及时发现和修复代码质量问题，减少手动工作和错误的可能性。
07 反馈和改进机制
如果开发者没有及时获得代码质量的反馈和改进机会，他们可能无法意识到自己的问题，并且无法改进自己的编码水平。
**▶︎代码质量评估和反馈：**建立起代码质量评估和反馈机制，定期对开发者的代码进行评估，并及时提供反馈。可以使用静态代码分析工具、代码审查等方法来评估代码质量，并向开发者提供改进建议和指导。
**▶︎学习和培训机会：**提供学习和培训机会，帮助开发者提升自己的编码水平。可以组织内部培训、技术分享会等活动，让开发者学习和分享最佳实践和经验。
**▶︎导师制度：**建立导师制度，为开发者提供指导和支持。经验丰富的开发者可以担任导师角色，与新手开发者进行合作和交流，帮助他们提升编码水平。
**▶︎代码评审和团队合作：**建立起代码评审和团队合作的机制，通过代码评审和团队讨论，开发者可以相互学习和改进。可以定期进行代码评审会议，让开发者分享自己的代码，并接受其他开发者的评审和建议。
**▶︎提供挑战和机会：**给开发者提供挑战和机会，让他们参与复杂和有挑战性的项目。通过参与这样的项目，开发者可以学习和成长，提升自己的编码水平。
08 个人实施案例
那是毕业后来到的第二家公司，接手了离职同事的“屎山代码”，整个项目只有一句注释，“佛祖保佑，永无 bug”。代码没有一点规范，变量命名清一色的 aabb，领导让我抓紧给个排期，项目要上线，我心想“我赶紧跑路的好！”，我直截了当说道：“这个项目整体没用规范，他可能都看不懂，我更看不懂”，后面还是勉强上线了，但问题较多，我的绩效一塌糊涂。我就在思考如何高效地开发代码和定位问题？并在我所在的这个项目中快速实施。
▶︎ “屎山一样的代码”我不可能一点点修复规范问题，有没有合适的工具可以提醒你呢，哪里问题较多，在我用了多个工具之后，我发现 CheckStyle 是我用过最好的代码规范检查工具，里面用了 sun 的规范。（后面在其他同事的协助下，共同搞定了一版公司自身的规范）。
▶︎ 后面慢慢的我定位问题和开发代码的质量越来越高，绩效也好了很多，在一些分享会中，我提了自己的建议，领导针对这些成果也是比较认可，最后成立了“代码规范小组”，定了一些规范制度：
开发人员互相 review 代码，不少于两个人看过之后才可以合并主线。提出问题的人可以得到奖励。“开发问题代码”的会受到惩罚（在两个月后开始执行）。你也可以对其他项目提出问题（背景：公司较小，项目又比较多和杂。这个的奖励是比较多的，对自己的个人时间占用较多，取舍全靠自己，没有硬性要求）。导师制度：带的新入职的员工如果近期发起的代码质量优秀或者取的了好绩效，导师会得到奖励。分享会：开发人员会找轮流进行分享，找一些开源代码或者经典案例进行解读。
经历了大概一年的时间的迭代，低质量代码逐渐消失了。后续我复盘这个过程，我发现有些运气的成分，遇见了一个很好的领导，一群优秀的同事，当然也和自身的努力分不开，如果自己没有想着去提升自己的代码规范从而快速地解决问题，就不会被领导看见代码规范的重要性，更不会去推动团队代码规范建设。
最后，我想告诉大家，当我们看到这些“屎山代码”的时候，我们应该偷偷地笑，先恭喜自己取得高绩效，根据实际情况并结合上述分析去推动团队制定代码规范和有效措施。投入实践，具体落实。希望每个人都能被看见。
-End-
原创作者｜孔垂航
让开发更简单！ 2018-04-23 加入
CODING 是腾讯云旗下一站式 DevOps 研发管理平台，向广大开发者及企业研发团队提供代码托管、项目协同、测试管理、持续集成、制品库、持续部署、云原生应用管理 Orbit、团队知识库等系列工具产品。
评论