有一些非常常见的编程错误是我们要避免的,以保持代码的干净和可读性。
在本文中,我将研究它们以及如何避免它们。
一个函数中的东西太多
一个函数应该只做一件事,这就是它自己所指示的。
如果有其他的东西,那么它应该被移动到它自己的函数中,在一个函数中有太多的东西会使阅读和理解变得困难。
例如,如果有一个既可以计算小计又可以计算税款的函数,则由于它们是不同的,因此应将其分为两个单独的函数。
注释掉的代码
注释掉的代码是不能运行的代码。因此,在我们完成代码的这一部分之后,它们不应该出现。
完成后,我们应该删除已注释掉或取消注释。
无论哪种方式,最终产品都不应在其中注释掉代码。
非描述性的变量名
以不传达其含义的方式命名变量,一旦我们忘记了自己写的那段代码,再回来看,就会让读者和我们自己感到沮丧。
因此,我们应该使用描述变量名称的变量来命名变量。
不要写成 let x;,而是写成像 let numApples 这样的东西,这样我们就知道我们的变量将持有苹果的数量。
魔法数字和字符串
我们不应该有魔术数字和字符串。这些值出现在多个值中,表示相同的东西,但在代码中没有明确解释。
例如,如果我们有以下代码:
- for (let i = 0; i < 10; i++) {
- ///...
- }
那我们不知道10代表什么。相反,我们应该将其设置为命名常量,以便我们了解其含义。
例如,我们可以这样写:
- const numApples = 10;
- for (let i = 0; i < numApples; i++) {
- ///...
- }
现在我们知道10实际上意味着苹果的数量。
凌乱的代码格式
凌乱的代码格式化会使代码难以阅读,因此我们应该使用lint或代码格式化程序对其进行清理。
那里有很多选择,因此我们可以使用Prettier或ESLint这样的工具自动进行整理。
硬编码值
我们不应该把值硬编码到我们的代码中,特别是当它们是私密的时候。相反,我们应该把它们作为环境变量,并从那里读取所有的值。
有很多方法可以做到这一点。例如,对于前端,Angular,React和Vue都有保留变量的位置,以将变量保存在不同文件中的不同环境中。
对于后端,我们可以使用诸如 dotenv 包之类的东西从 .env 文件中读取环境变量,这样我们就不必对它们进行硬编码。
重复代码
重复的代码是不好的。如果我们改变一些重复的东西,就必须在所有重复的地方都要改变它们。
相反,我们应该将公共部分移动到它们自己的文件中,以便可以在多个地方使用它们。
不重复使用(DRY)原则适用于所有地方。如果我们完全照原样复制和粘贴并使用它们,则应将其移动到共享位置。
不备份代码
我们应该使用Git管理代码,以便我们可以为我们的代码提供本地和远程存储库。
这样,我们可以自动将一个副本保留在远程位置。同样,我们可以轻松地还原错误代码,并轻松地从较早的提交中获取代码。
没有版本控制,我们无法做到这一点。
如果我们没有备份代码,那么如果出现问题,我们可能会丢失所有内容。
复杂代码
应该简化复杂的代码,以便我们更容易理解它们。
我们还应该将它们分解成较小的部分,以便我们可以重复使用某些内容,并具有易于阅读和测试的单个部分。
总结
这些常见的错误,只要我们在做事情的时候注意点,是很容易避免的。
将事物分解成小块总是好的,就像保持事物简单而不重复一样。
注释掉了,没有描述性的变量和值也应该用更有意义的东西代替。