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

这三种技巧可以将你的代码的可读性提高300%

时间:2023-03-22 01:18:11 科技观察

注意!注意力!如果你想成为一名优秀的程序员,你必须遵守一些不成文的规则。这篇文章不是在讲算法、数据结构、软件架构和编程,而是更基础和重要的东西:可读性。源代码是程序员耗尽心血和精力的作品,所以不应该出现“快刀斩乱麻”的现象。忽略这些规则可能看起来会导致更快的代码生成,但实际上往往事倍功半。代码输入一次,阅读无数次。因此,优化代码以提高可读性就显得尤为重要。为了帮助生成高度可读的代码,本文总结了三个必须遵循的重要规则。遵循这些规则可以帮助那些使用代码的人维护、扩展和调整它。此外,更具可读性的代码更不容易出错。这三个技巧最好的部分是它们可以立即实施。不需要培训时间。在短短几分钟内转变为更好的程序员!使用描述性变量和函数名称程序代码通常包含数千个单词。当然,也有更短的代码。使用不言自明的变量和函数名称,使代码更易于阅读、理解、维护和后续扩展。举个例子:在编写这段代码时,开发人员确切地知道正在实现什么样的功能。可是,别人能看得懂吗?这取决于灵感和命运。开发人员可以添加注释来描述这段代码的作用,但使用描述性变量名称更直观地告诉读者相关信息,例如:看!现在是不是更容易理解了。仅仅通过使用描述性的变量名,读者就可以立即理解代码将华氏温度(Fahrenheit)转换为摄氏温度(Celsius)。现在定义一个函数来实现上述代码功能,观察函数名和参数名对可读性的影响。“简短”版本:“添加详细信息”版本:很明显:“添加详细信息”版本比变量和函数名称只有单个字母的“简短”版本需要更多的输入。但是理解两个版本的代码需要多长时间呢?自解释代码不仅为读者节省了大量理解代码的时间,也为开发人员节省了大量时间。为了更改程序细节或编写扩展,开发人员通常需要审查几个月前编写的代码。然后我困惑地盯着屏幕:“天哪,我写了什么?任何可以优化可读性的东西都值得额外的打字时间。使用适当的缩进,因为GuidovanRossum在他的决定中决定缩进在Python编程语言中由设计,所以使用Python编程的读者可以跳过这一部分。如果您正在使用其他流行的编程语言,如C、C++、Java、JavaScript、PHP、C#、PHP等,那么请记住这个提示:按层次缩进代码。可以使用制表符或空格,空格可以按开发者的喜好按3次或4次。请记住,缩进在编程中是必须的。让我们通过比较一些JavaScript代码来更进一步。此代码:将100到110华氏度转换为相应的摄氏度。将转换后的值四舍五入到个位(使数据成为整数)。将所有偶数摄氏度值输出到控制台(这是通过使用模运算符“%”完成的,它返回整数除法的余数。所以,11%2=1,12%2=0)没有缩进的版本缩进:代码中还加入了一些空行,进一步结构化代码。这两段代码哪一段更具可读性?正确使用函数通过使用函数,您可以构建可重用的代码块。这些也使代码更加结构化、可读性和可理解性。能够避免重复代码是函数最重要的特性。定义函数(或类、模块等,取决于使用的编程语言)可以解决代码库中同一段代码多次出现的冗长状态。下面的例子就是一个很好的例子:上面的代码输出一个华氏度值和相应的摄氏度值。很明显,上面的代码中有重复的代码段。在这种情况下,创建一个函数可以更快的完成上面的功能:更清爽,对吧!代码看起来更干净简洁。此外,它比前面的示例更具描述性。该公式只会在定义ConvertAndPrint函数时出现一次。如果您只想将华氏度转换为摄氏度而不显示数据怎么办?您可以通过定义不同的函数来做到这一点:是的!这些构建块以多种方式被重复调用。这就是结局?不!还是有一些地方代码重复的很厉害。PrintFahrenheitAndCelsius函数需要4个值作为输入。那么当你只想转换3个值时怎么办?如果要转换300个值怎么办?当然还有更好的办法!根据所使用的编程语言,抽象函数参数个数的方法可能不尽相同。但是,大多数开发人员会通过使用矩阵或列表等容器来解决这个问题。最后的更改使函数变得更好:它更短、更易于阅读、限制更少且更通用。结语遵循一些简单的规则(规范化指南)将使源代码更易于阅读(从而进一步理解、维护和扩展)。同时,使用函数(或其他编程语言中的任何抽象方法)创建可以重复调用的构建块。将参数抽象化使得代码的限制更少,应用范围增加。函数和变量的适当重命名可以增加源代码的可读性。它像读故事一样清晰、简单、易懂。有了这三个技巧,你的代码就会感觉像被带回了生命,闪闪发光。