如何提高代码的可维护性?


通常来说 。在任何一个项目组中都应该有各自的编码规范 。目的就是为了增加代码的可读性和可维护性 。那么 。到底该如何做呢?
1/7 分步阅读
变量命名要有意义 。最好是使用英文命名 。实在不行的 。使用拼音 。除了循环中的计数变量 。以及特殊场景之外 。任何变量都尽量不要使用a、b、c这类完全没有任何意义的名称 。增强可读性
2/7
变量除了要有意义之外 。还需要统一大小写 。比如第一个单词首字母小写 。后续单词首字母大写的命名风格 。风格统一后 。看着代码都会心情舒畅一些 。从而可读性更好
3/7
添加必要的注释 。虽然 。某些变量名可以看出意义 。但是 。必要的注释可以更为直观的让人看懂代码 。增强可读性
4/7
增加代码段的注释 。如果是C#语言 。可以使用region语法包裹一段逻辑 。到时候折叠起来 。看起来整体性就很容易阅读 。其他语言可以使用比较明显的分隔符号标明段落
5/7
将很长的函数拆分成较小的函数 。这样不仅可以增加代码的可读性 。还能增加代码的可维护性
6/7
将代码划分层次 。比如 。访问数据库的代码单独放在一个项目中 。前台代码单独放一个项目中 。到时候修改的时候就很明确 。不至于四处乱找 。增加可维护性
7/7
代码的层次之间通过接口来调用 。减少各个层次之间的耦合度 。增加可维护性
【如何提高代码的可维护性?】

如何提高代码的可维护性?

文章插图
如何提高代码的可维护性?

文章插图
如何提高代码的可维护性?

文章插图
如何提高代码的可维护性?

文章插图
如何提高代码的可维护性?

文章插图
如何提高代码的可维护性?

文章插图
如何提高代码的可维护性?

文章插图
其他观点:
最好就是把这个代码能有注释 。这样后续的代码修改 。方便快捷
其他观点:
可维护性代码 。要求我们的代码易于理解 。如果可以用更少的注释来完成这一功能 。势必事半功倍!
1、命名
函数命名:避免函数名使用含糊的字眼 。使用主动动词表示函数主动执行 。
变量命名:变量的命名一定要是一些有意义的名词 。比如userName 。而不是a、b、i之类;代码中禁止出现“魔数”(在代码中出现但没有解释的数字常量或字符串) 。
PS:变量命名采用英文 。千万不要出现有创意地拼写错误 。比如:SetPintleOpening 。SetPintalClosing 。这样估计后来维护者全局搜索代码时要崩溃 。
2、函数封装
函数封装最大的好处就是避免代码重复 。
举个栗子:
下面这样的代码 。估计没有注释的话 。一般人都要抓狂 。很难看懂吧 。
如何提高代码的可维护性?

文章插图
我们看看引入函数之后的例子 。该函数名明确地表达了它要做什么 。这样一来就不必写注释了 。而且 。如果有需要后面还可以直接调用此函数 。一举两得 。减少了重复劳动 。
如何提高代码的可维护性?

文章插图
3、引入变量
用变量代替表达式 。看下图的例子 。可能第一次接触代码难以理解其真实表达的意图 。
如何提高代码的可维护性?

文章插图
如果引入变量 。而不是函数 。能否解决这个困扰呢?答案是肯定的 。请看下图:
如何提高代码的可维护性?

文章插图
4、代码分组
尽可能将变量定义在靠近使用它的地方 。并且尽可能将变量分门别类 。这样更方便后来人对代码的维护 。
看下面的例子 。很显然 。左侧的代码将foo的所有使用组合放在一起 。一眼望去就能知道各种关系 。如果可以的话 。尽量选择代码分组 。
如何提高代码的可维护性?

文章插图
5、统一编码规则
无规矩不成方圆 。同一个项目组 。必须统一编码规范 。试想一会驼峰命名法 。一会儿又匈牙利命名法 。这代码看起来得有多别扭 。

    推荐阅读