表达原则:如何让代码成为一种逻辑线索

在开发过程中会经常遇到一下问题:

1. 接受维护项目,却发现文档缺失,代码无注释,维护人员离职,基本只能靠猜来梳理代码逻辑
2. 代码风格过于抽象(命名过短,魔鬼数字,重名方法等),看不懂,也不敢轻易修改
3. 运行代码出现故障时,不打日志,不抛异常,导致定位问题需要耗费很长时间
4. 大段的 if-else 代码嵌套,调用逻辑复杂冗长,扩展性差,重构优化费时,费力

造成了这些的原因都是:

1. 代码的可读性差
2. 没能很好的串联代码内的逻辑

提升代码可读性的好处:

1. 更易于维护:代码写好后需要调试,运行,修复bug, 设计文档,需求文档和口头交流只能表达部分业务逻辑的意图,而代码则能反映出编程实现业务逻辑时的全部真是意图,可读性高的的代码能让程序员在阅读代码时快速理解编写者意图,即便逻辑复杂也能在修改时准确的分析和理解,大大节省维护和修改代码的时间
2. 更易于重构:现在的项目之所以难以重构就是因为代码的可读性差,当你无法理解一段代码时你会跳过他,而整个系统都难以理解的话你就会选择重写而不是重构,因为重构必然修改原有代码,则会有一定风险,所以可读性的额高低决定了你重构意愿的大小
3. 更易于测试:代码的运行时需要反复调试,如果代码的可读性很差,很多时候都会写一些额外的测试接口来对原有的接口进行测试,不仅浪费时间还会造成误读,可读性高的代码参数与输出都更加清晰,在测试时能更精准的找到对应逻辑和问题点
4. 更易于应用设计模式:设计模式除了在设计之初被使用外,其实更多时候都是在代码在重构过程中被使用.

总的来说提升代码的可读性可以帮助我们更好的理解代码和帮助阅读代码的人快速找到代码的实现逻辑

你可能很讨厌写文档也可能没有太多时间阅读文档这是表达原则就可以帮到你
表达原则指在编程时应该有清晰的编程意图并通过代码明确的表达出来,通俗的说就是代码及文档

要写出有逻辑线索的代码主要从三个方面入手

1. 代码的表现形式:在命名(变量名,方法名,类名),代码格式,注释等方面改进
2. 控制流和逻辑:尽量分离控制流和逻辑,让代码变得更容易理解
3. 惯性思维:找出常犯的一些惯性思考方式并逐一改进,避免一次性代码,避免复杂粘贴代码,避免超长代码,避免过度简单化的命名和表达式