带/不带参数的命名约定,造成混淆错误?

时间:2017-12-27 08:31:25

标签: java naming-conventions naming

我在一个名为的类中有两个参数: textWithHeader textWithoutHeader 他们的名字很混乱! 添加get方法是getTextWithoutHeader()+ IDE自动完成的事实,它们很容易混合在一起。

在代码中的一些地方,一些开发人员在他们之间混合,导致系统中一些非常困难的错误。

此类参数是否有任何命名约定?

好,但没有雪茄:

  • 更改为文字 textWithHeader 不够明确。
  • 更改为 headerlessText TextWithHeader ,会将它们放在彼此相邻的自动填充上,我想保留它。

2 个答案:

答案 0 :(得分:2)

我建议将它们称为 headerlessText textWithHeader 你保留了意思,但名字不同,不要混淆。

答案 1 :(得分:1)

嗯,他们看起来并不会让我感到困惑:至少对我来说。

他们遵循Java" camelCase"变量的约定,并且具有足够的描述性。你无能为力。

虽然如果你想停止两件事的隐式转换,你总是可以将它们包装在不同的类中:

class TextWithHeader
{
    public final String s;
}

class TextWithoutHeader
{
    public final String s;
}

也许那时,您的TextWithHeader班级甚至可以提供方法getTextWithoutHeader()