当前位置: 首页 > 科技观察

代码工作的关键一环:如何组织代码?

时间:2023-03-13 11:28:37 科技观察

本文转载自公众号《核心阅读》(ID:AI_Discovery)。代码结构作为代码工作的重要组成部分,难度相当大。要写出结构良好的代码,需要编写者有正确的思维方式,对设计模式有自己的理解,并且有丰富的经验。通常,为了培养上述能力,你必须走很远的路。代码结构的重要性不容小觑,从可读性和可维护性的角度来看,代码结构非常重要。第1课:提前设计在开始编写代码之前,您最好考虑提前设计要构建的应用程序,UML图是一个不错的选择。如果编写者在编写代码之前有一个计划,他们可以更加专注。通过提前考虑代码的结构并创建一些有用的UML图,可以提前避免许多明显的陷阱。更重要的是,有一个计划可以让我们意识到,在编写代码之前,编写者需要考虑很多事情。UML图还可以防止代码编写者“走神”,避免向他们认为将来会派上用场的代码添加不必要的功能。在没有计划的情况下一头扎进去会让你一开始会更快一些,但跳过这一步最终将不得不重构大量代码,耗费大量时间和精力。记住,欲速则不达。第2课:类和函数指南以下指南可以帮助您保持类和函数的可读性和可维护性:使类和函数尽可能小类和函数应遵循单一职责原则使类和函数尽可能小代码是更容易理解。一般来说,较大的类和函数应该分解成较小的专用类。遵循单一职责原则可以帮助您保持类和函数的小型化,即每个类、每个函数只做一件事。但是要注意,它应该是在合理范围内的“小”,因为在大多数情况下,太多的小类比几个大类要差得多。将功能分解成像“获取、处理和存储数据”这样的大功能是行不通的。您必须将此功能分解为三个较小的功能:分别用于提取、处理和数据存储。第3课:使用设计模式了解设计模式及其工作原理可以帮助您编写更加结构化、可读和可维护的代码。如果你知道在什么情况下使用哪种设计模式,你就不用自己去琢磨了,只要遵循设计原则,保持代码整洁即可。但是要小心,不要过度使用设计模式,这是使用这种方法时最常见的陷阱。虽然设计模式可以在特定情况下使用,但过度使用设计模式对编写者弊大于利,使应用程序过于机械化,并使其他开发人员难以理解代码。第4课:代码规范代码结构在很大程度上与代码规范相关。对于每个项目,代码规范都是必要的。如果没有代码规范,代码迟早会变得凌乱难读。我们可以做一个代码规范的列表,记录声明变量的方法,命名约定等。你可以在列表中无限添加规则,规则的数量也可以变化,只列出对你和你的人有帮助的规则团队。团队成员还可以随时在规范列表中添加或删除规则。列出规格后,请坚持使用!第5课:编写单元测试编写单元测试可能会产生意想不到的效果,它使您不得不构建代码。为了能够编写单元测试,至少要保证代码的结构是正确的。也许你以前听过或写过不可测试的代码,如果有一段代码让你疑惑如何编写单元测试,那可能是因为这段代码功能太多,或者写得不好。无论哪种情况,代码无法测试的原因只有一个,那就是结构不佳。当你遇到不可测试的代码时,你会发现自己大部分时间都花在了重构上。单元测试可以作为一种约束,迫使您构建代码。资料来源:Unsplash有几种实现代码结构的方法。它在您键入第一个代码字母之前开始,包括提前思考应用程序的设计、创建帮助编写者消除明显缺陷的UML图等等。每当您要编写代码时,都应该确保您有一份可以遵循的代码规范表。学习使用设计模式可以进一步帮助你实现这个目标。同时,你还需要保持类和函数单元小,让这些类和函数只做一件事。最后,养成编写单元测试的习惯,否则只会得到一堆无法测试的代码。更加认真地构建代码!