读取源代码是软件开发人员的工作描述之一。但是,这种经历并不总是令人愉快的。并非每个人都喜欢阅读别人的代码,因为他们觉得代码很无聊,有时很沮丧。在某些情况下,当您开始阅读别人的代码但最终因无法理解或代码编写得不好而感到痛苦。大多数开发人员希望专注于主要编写代码而不是阅读,而不是意识到阅读代码也是一种技能。
但是,阅读源代码有很多好处。阅读代码的收益是巨大的。可以将编码与文献进行比较。您会看到,大多数作家在写作时都专注于阅读伟大的杰作。原因是您不能仅凭空创造任何东西。您必须吸收来自不同来源的事物,并在此基础上开展工作并创建自己的杰作。编写代码与此没有什么不同。
为了能够编写好的代码,您必须阅读很多好的代码。这样,您可以了解其他开发人员的想法以及他们如何解决特定问题以及他们缺少的地方。您可以通过阅读其他代码来接受不同的想法,样式和模式,并逐渐增加自己的知识。
如果我们想用简单的话来表达,那么代码阅读技能可以提高编码技能。
有几种提高阅读技巧的方法,在本文中,我想提到一些
1.运行代码–好吧,这是阅读代码的第一步。能够立即运行特定项目使您获得了进一步发展的精神认可。但是,这可能不会为您提供有关该项目的许多详细信息,但是,您将知道如何构建和运行该项目,还可以了解其使用的库,其依赖的框架等。增进对特定项目的了解的好方法。如果您要编写自己的软件,类似于正在探索的特定项目,则可能会对可能使用的框架或库有所了解。
2.查找高级逻辑–刚开始阅读项目时,您可能不会跳入每个细节,而应该专注于高级结构。从入口点开始。大多数项目都有一个主要方法,从那里开始。此外,如果这是一个Web应用程序,则开始研究不同的程序包,例如业务逻辑代码在哪里,UI代码在哪里,控制器在哪里等。基本上,浏览整个项目并获得一个基本的想法,然后询问问自己一个问题,您想重点放在哪里,首先要阅读哪一部分。您可能不会阅读整个代码库,但可能会阅读其中的一部分。找到位置后,您可以从方法调用开始,然后查看它的位置。
3.使用/了解工具-有很多工具可以阅读和探索可帮助可视化代码的源代码。例如,IntelliJIdea实际上具有导航源代码的强大功能,您可以在其中按单词,单词的一部分甚至缩写进行搜索。您还应该学习键盘快捷键。使用鼠标导航源代码可能很无聊且很慢,而使用键盘快捷键可以更快。您可以从源代码的一部分快速跳转到另一部分。
还有另一种很棒的读取代码的软件,称为Sourcegraph,它是由两个斯坦福大学的毕业生Quinn Slack和Beyang Liu创造的,他们花了数小时寻找那些文档不完善的代码后,决定建立一个工具来帮助他们更好地阅读和理解。代码。
4.了解语言/约定-深入了解特定语言可以帮助您提高代码阅读技能。每种语言都有自己的一套约定,样式和语法。了解这些有助于快速熟悉特定的代码。例如,在Java中,方法名称以小写字母开头,而C#则以大写字母开头。知道这一区别后,可以帮助您从源代码中识别方法。
5.阅读最佳实践/设计模式-您正在阅读的代码,其中的某些构造看起来很晦涩或未知,这是很自然的。人们使用许多良好的实践和设计模式来正确,最佳地完成工作。例如,有一个称为Singleton的模式,其中的构造函数保持私有状态。您可能会问,为什么到底有人必须使构造函数私有,我一直认为它是公共的,否则我将如何从类中创建实例。好吧,背后有一个原因。单例模式可防止实例多次实例化一个具有很多实际用例的类。如果您知道该模式,则不会因此而将头撞在墙上。因此,了解某些模式(例如,“四人帮”拥有23个文档化的设计模式)可以极大地帮助您提高代码阅读技能。
6.代码审查–软件开发是一项非常协作的工作。没有人可以单独构建大型或重要软件。每个软件都以团队的形式构建。在团队中,每个人都为制定项目做出了贡献。最终,每个人的贡献都将融合在一起,成为一件对客户具有真正价值的出色工作。除了进行实际的编码外,如今每个团队还有另一种做法,那就是检查彼此的代码,以观察,提出建议并互相学习。这是一个强大的工具,可用于构建代码库知识,在团队中建立牢固的联系并提高代码质量,从而减少系统中的错误并获得满意的客户。
在进行代码审查时,您被迫阅读团队中其他人的代码,最终提高了代码阅读能力。
7.临时重构–临时重构还可以帮助您提高代码阅读技能。您可以从采用长方法开始,然后将方法分成多个方法。继续这样做,直到您了解更大方法的意图。之后,您可以记下该方法的功能,然后回滚更改。
这可以帮助您了解方法的构造,也可以提高您的重构知识。
原文出处是英文,老外编写,本人认为很有价值所以翻译过来发布。
转载来源:https://dev.to/bazlur_rahman/-7-ways-to-improve-your-code-reading-skill-1b11