Changing Legacy Code: With Confidence

• 语言: 英语
• 格式: .pdf
• 来源: github.com/CppCon

摘要

文档讨论了处理遗留代码（Legacy Code）的挑战与方法。遗留代码虽然目前仍在为公司带来收益，但可能缺乏测试、结构复杂且难以维护。处理遗留代码时，需要逐步改进，引入测试，确保代码自我文档化，并在变更时保持信心。文档强调了在维护过程中应遵循的最佳实践，如始终提交可运行的代码、逐个变更并设定时间限制，以及通过重构和文档记录来提升代码质量。

AI总结

《Changing Legacy Code: With Confidence》文档总结：

### 文档总结

1. **遗留代码的定义与价值**
- 遗留代码是指目前为公司带来收入的代码，即使它可能没有测试或文档，但已被验证可靠运行。
- 遗留代码反映了项目历史中的决策和问题，尽管可能存在争议（一人的bug可能是另人的关键功能），但其本身具有价值。

2. **遗留代码的特点与挑战**
- **特点**：代码仍在运行并支持业务，但可能缺乏清晰的结构，随着时间推移，最佳实践、工具和开发人员的变动可能导致代码难以维护。
- **挑战**：开发者可能对项目结构缺乏深入理解，支持工具和技术栈可能更新换代，导致维护困难。

3. **改善与迁移遗留代码的目标**
- 保留现有功能的同时逐步改善代码。
- 引入测试，提升代码质量和可维护性。
- 通过清晰的文档和结构，使代码更易理解。
- 增强开发者对代码更改的信心，降低维护成本。

4. **实用建议**
- **提交代码规则**：
- 始终提交“可工作的代码”。
- 每次提交只做一次改动，避免复杂的多变更提交。
- 设置时间限制，避免无止境的优化。
- **新代码开发**：
- 新代码应独立测试后再整合到旧代码中。
- 通过测试和文档保持新代码的可维护性。
- **软技能需求**：
- 维护遗留代码需要耐心、判断力和沟通能力。
- 需要平衡代码性能、最佳实践和现实约束。

5. **总结**
改善遗留代码是一项需要耐心和技巧的工作，既要关注技术细节，也要具备良好的软技能。通过逐步改进和引入测试，可以提升代码的可维护性和开发者的信心，降低未来的维护成本。