java - 从可读性角度来看 Java 变量的最佳名称长度

Question

考虑以下 Java 代码片段中的常量:

public class ConsumerServiceTestFixture {
    private ConsumerServiceTestFixture() {
        throw new AssertionError("This class should not be instantiated");
    }

    public static final String CUSTOMER_ID_NOT_INTEGER = "12345678901";
}

上面的常量CUSTOMER_ID_NOT_INTEGER用于存储无法转换为整数的字符串，因为它的值大于Integer.MAX_VALUE。

从变量名称中看不出来，该变量充其量表示该值是“无效”customer_id。没有说明为什么该值无效。

一种选择是写一条评论，内容如下:

// Invalid since this number is greater than Integer.MAX_VALUE
public static final String CUSTOMER_ID_NOT_INTEGER = "12345678901"; 

但是，如果我们必须编写自记录代码而不使用注释，那么唯一的其他选择就是使变量名称更具描述性。像这样的东西:

public static final String CUSTOMER_ID_GREATER_THAN_INTEGER_MAX_VALUE = "12345678901"; 

但是，使用上述选项时，我对变量名称的长度不满意，特别是如果您考虑以下代码完成 2 中有关最佳变量名称长度的片段:

您建议我如何平衡变量名称的长度与代码可读性？

Answer 1

如果您使用/** 注释(即 javadoc)而不是//注释，那么当程序员从 IDE 中使用您的常量或查看您的 javadoc 时，他将获得所有优点和优点的完整解释。这种设计的缺点，为什么这样做等等......

遗憾的是，您无法将其命名为“CUSTOMER_ID_THAT_IS_A_STRING_BECAUSE_IF_IT_WAS_AN_INT_IT_WOULD_BE_TOO_LARGE”。