构建之法阅读笔记04

​​第四章：代码规范与质量保障​​
​​我过去是怎么做的​​
过去，我在编写代码时，往往更关注功能的实现，而忽略了代码的可读性、可维护性和规范性。例如：
​​命名随意​​：变量名使用a、temp等无意义的名称，函数名不能清晰表达其功能。
​​代码冗余​​：存在大量重复代码，未进行合理的函数封装或模块化设计。
​​缺乏注释​​：关键逻辑没有注释，导致后续维护时难以理解代码意图。
​​忽视测试​​：仅依赖手动测试，未编写单元测试或集成测试，导致回归测试效率低下。
​​风格混乱​​：缩进、括号风格不一致，不同模块的代码风格差异大，影响团队协作效率。
这些问题导致代码库逐渐变得难以维护，修改一个功能可能引发多处意外错误，技术债务不断积累。
​​结合书中所讲​​
《构建之法》第四章强调，​​代码质量是软件工程的基石​​，良好的代码规范不仅能提升可维护性，还能减少团队协作成本。书中提到几个关键点：
统一的命名规则（如驼峰命名法、下划线命名法）能提高代码可读性。
一致的代码风格（如缩进、括号位置）减少团队成员的理解负担。
合理的注释和文档能帮助后续开发者快速理解代码逻辑。
​​代码质量保障手段​​，静态代码检查​​（如ESLint、Pylint）能自动发现潜在问题，如未使用的变量、不规范的命名等。单元测试​​（Unit Test）确保每个模块的正确性，减少回归测试成本。代码审查​​（Code Review）通过团队协作发现潜在问题，提高代码质量。定期重构（Refactoring）消除代码坏味道（Code Smell），如重复代码、过长函数等。
使用设计模式（如工厂模式、策略模式）提高代码的可扩展性。
书中特别强调，​​“代码是写给人看的，其次才是给机器执行的”​​，因此代码的可读性和可维护性比“快速完成”更重要。
​​提出解决办法​​
​​制定并执行代码规范​​
采用业界通用规范（如Google Style Guide），并结合团队实际情况调整。
使用自动化工具（如Prettier、ESLint）强制统一代码风格。
​​加强测试覆盖​​
为关键模块编写单元测试（如Jest、Pytest），确保核心逻辑的正确性。
使用持续集成（CI）工具（如Jenkins、GitHub Actions），每次提交自动运行测试。
​​定期重构与优化​​
每周安排1-2小时进行代码重构，逐步消除技术债务。
使用SonarQube等工具分析代码质量，识别高风险代码。