2020-10-20 12:48:18
优秀程序员写代码时,为增强可读性并降低复杂度,通常会采用以下11条实践经验:

格式统一:不必在制表符与空格、Allman与K&R等格式问题上过度纠结。选择一种合适的代码格式并应用到项目中,然后通过自动化工具确保格式的一致性,从而将精力集中在代码逻辑本身。
清理死代码:及时移除注释掉的代码块、未使用的变量和无法到达的代码。这些死代码会干扰阅读,引发破窗效应,导致代码质量逐渐下降。
减少嵌套代码:嵌套代码会增加人类读者的精神负担。通过防御语句、提前返回或函数式编程等技术,减少代码的嵌套层级,使逻辑更加清晰。

使用对象重构:避免过度使用原始指令和杂乱的数据结构。将长长的参数列表、自定义数组或字典等重构为对象,使数据结构更加正规,并容纳重复逻辑。
控制代码块长度:虽然没有固定的数字限制,但过长的代码块应被识别和重构。通过拆分代码块,可以明确上下文和抽象级别,提高代码的可读性。
优化命名规则:好的命名需要时间和实践。不必在编写代码时过度纠结命名,可以先使用临时名称,完成功能后再优化。即使使用一整句话命名变量也是可行的。
删除冗余注释:大多数情况下,代码应该自解释。删除冗余注释,将精力放在提高代码本身的可读性上。只有在极特殊情况下(如与古老适配器连接返回不明值),才需要添加注释。
合理设计返回值:避免返回奇怪的值(如-1、687或null),这些值会增加处理逻辑的复杂性。努力返回有意义的值,或在异常情况下采用其他通信方式。

遵循三的原则:不要过早进行抽象。在有足够多的信息(如三个重复的代码段)之前,保持代码的重复性。重复的代价远低于错误的抽象。
追求代码对称性:对称性是指同样的思想在任何地方都使用同样的实现。这需要多年的实践来掌握,但一旦应用,代码的形状和可读性会显著提升。
持续重构与优化:代码的可读性和质量需要持续维护。定期审查代码,识别并重构过长、复杂或难以理解的部分,确保代码始终保持清晰和简洁。
这些实践经验不仅适用于特定语言或项目,而是具有普遍性。通过遵循这些原则,程序员可以编写出更加易读、易维护的代码,从而提高开发效率和软件质量。