一些避免魔法数的方法

只看该作者 · 2023-8-23 10:54

"魔法数" 通常是指在代码中直接使用的未经解释或命名的常数值，这会使代码变得难以维护和理解。以下是一些避免魔法数的方法：

使用常量或枚举：将常数值定义为常量或者枚举，然后在代码中引用这些常量或枚举而不是直接使用数值。这样做可以使代码更具可读性，也方便统一修改。

复制

// 不好的写法（魔法数）：

double circleArea = 3.14159 * radius * radius;



// 好的写法（使用常量）：

final double PI = 3.14159;

double circleArea = PI * radius * radius;

命名有意义的变量和常量：将变量和常量命名得有意义，以便于读者理解其用途。这会减少对于魔法数的依赖。

只看该作者 · 2023-8-23 10:55

提取配置或设置：如果可能的话，将常用的数值提取到配置文件、设置文件或者参数中。这样可以在不修改代码的情况下更改这些数值。

只看该作者 · 2023-8-23 10:55

本帖最后由 1988ChenSir 于 2023-8-23 10:57 编辑

使用注释解释常数的含义：如果不可避免地需要使用常数，至少使用注释来解释这些常数的含义和用途，这样其他人阅读代码时可以更容易地理解。
使用函数或方法：将一系列操作封装到函数或方法中，并将函数的参数设计为能够传入相关的数值。这样可以避免在代码中直接使用魔法数。

避免硬编码：将常数值硬编码到多个地方会增加修改的难度。尽量将常数值定义一次，然后在需要使用的地方引用。

代码审查和重构：定期进行代码审查，让其他人审核你的代码并提出改进建议。在代码的演进过程中，随时进行重构以减少魔法数的使用。

遵循这些方法，你可以有效地减少魔法数在你的代码中的出现，使代码更加清晰易懂，更容易维护。