为什么我不接受任何幻数

我想在一个新项目中建立的第一件事就是使用诸如Checkstyle和Findbugs之类的工具,以便整理一些代码准则并避免可以由静态代码分析确定的错误。

迟早使用这些工具时,人们会偶然碰到一种情况,即人们感觉它已经走到了尽头。 一种这样的情况是检查Checkstyle的幻数 。 它会警告您不要使用数字文字,除了-1、0、1和2以外,这些数字文字不会用于定义常量。

从结果代码中可以看出,许多开发人员对此检查存在问题。 我看过这样的代码:

private static final int FOUR = 4;

并且

private static final int FOUR = 5;

和我一直以来的最爱(我没有弥补!):

firstname = rs.getString(1);
lastname = rs.getString(2);
city = rs.getString(2 + 1);
zip = rs.getString(2 + 2);
country = rs.getString(2 + 2 + 1);

但是在另一种情况下,讨论开始了。 它具有明显的常数,例如100用于将分数转换为百分比值,或1024用于在字节和千字节之间进行转换。 有人认为这些不是幻数(或幻数,但不是那么坏),因为它们的含义很明显并且不会改变。

我不同意,并且会随时投票决定使它们不变。 原因如下:

  1. 含义不明显。 值* 100是什么意思? 分数是否转换为百分比? 长度是否以米为单位换算为厘米? 还是乘以g * g的近似值,而g是地球上的重力加速度呢? 或者,也许我正在将某事乘以一个数组的大小,恰好是100。无法分辨。 一个具有适当名称的简单常量将解决此问题。
  2. 好的,我同意,其中许多常量不会更改。 但是,定义常量(或方法或类)的目的不是(仅)允许以后进行更改,而是使阅读,理解和推理更加容易。 因此,未来价值是否会改变的问题完全无关紧要。
  3. (这是我在大多数讨论中都遗漏的论点)我只是不想考虑它或让其他人考虑它。 我已经看到了数十个(可能是数百个)实例,其中一个适当命名的常量将有助于极大地理解一段代码。 而且我见过的少数情况可能会损害可读性,而没有哪一种情况会严重影响可读性。 因此:只需提取一个常数并使用它即可。

注意:仅因为它是一个常量并不意味着它必须是公共的,甚至不是类级别的字段。 如果仅在单个方法中使用它,则局部变量就可以了。

翻译自: https://www.javacodegeeks.com/2014/12/why-i-wont-accept-any-magic-number.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值