构建之法阅读笔记01

今天读到的是关于代码规范部分
一、书中内容简述
在《构建之法》中,代码规范涵盖了多个重要方面。代码风格规范主要包括代码的格式,如缩进、换行、命名规则等。统一的缩进可以使代码结构清晰,易于阅读;合适的命名能够让代码的功能一目了然,比如变量名和函数名应具有描述性,能够准确反映其用途。
代码设计规范则着重于代码的架构和模块划分。良好的代码设计应遵循模块化原则,将不同的功能封装在独立的模块中,模块之间通过清晰的接口进行交互,以提高代码的可维护性和可扩展性。同时,要考虑代码的可测试性,便于对代码进行单元测试和集成测试,确保代码的质量。
二、过去的做法
在过去的编程过程中,我的代码风格存在诸多问题。在代码格式方面,缩进随意,导致代码结构混乱,自己在回头查看代码时都常常难以理清逻辑。
命名方面更是随意,(因为平时写作业总以为是自己完成而且写完也大概率不会回过头去看,很多情况都会随意命名,这个习惯很不好),比如变量名常常使用简单的单个字母或者没有实际意义的缩写,函数名也只是简单地用虽然会用动宾格式,但有时有相似功能就往后堆加123,导致方法混乱。
在代码设计上,没有模块化的概念,所有的功能都混杂在一个文件中,函数之间的调用关系错综复杂,没有清晰的层次结构。当需要修改某个功能时,往往牵一发而动全身,很容易引入新的错误。
三、过去做法不好的原因
从书中的观点来看,我过去的做法存在很多弊端。首先,随意的缩进和格式使得代码难以阅读,对于团队协作来说,其他成员很难快速理解我的代码逻辑,增加了沟通成本。
不规范的命名方式使得代码的可读性极差,无论是自己还是他人,在维护代码时都需要花费大量时间去猜测变量和函数的功能,降低了开发效率。
没有遵循模块化的设计原则,使得代码的可维护性和可扩展性几乎为零。当项目规模逐渐扩大时,代码会变得越来越难以管理,新功能的添加和旧功能的修改都变得异常困难。而且,由于代码没有良好的结构,进行测试也变得非常困难,无法保证代码的质量。
四、以后的改进措施
为了避免再次重复过去的错误,我将从以下几个方面进行改进。在代码风格上,严格遵循统一的缩进规则,选择使用空格或者制表符中的一种,并在整个项目中保持一致。对于变量和函数的命名,采用标准代码规范,准确描述其功能。
在代码设计方面,学习并运用模块化的思想,将不同的功能封装在独立的模块中。在创建模块时,明确模块的输入和输出接口,确保模块之间的耦合度较低。同时,注重代码的可测试性,在编写代码的同时编写单元测试,及时发现和修复代码中的问题。
通过学习《构建之法》中关于代码规范的内容,我深刻认识到自己过去编程习惯中的不足之处,也明确了未来改进的方向。我相信,通过不断地实践和改进,我的代码质量一定会得到显著提高。

posted @ 2025-03-17 21:21  Look_Back  阅读(28)  评论(0)    收藏  举报