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

问题描述 投票:0回答:2

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

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

这种类型的参数是否有任何命名约定?

好,但没有雪茄:

  • 更改为text和textWithHeader不够明确。
  • 更改为headerlessText和TextWithHeader,会使它们在自动完成中彼此不相邻,我想保留它们。
java naming-conventions naming
2个回答
2
投票

我建议把它们称为headerlessText和textWithHeader你保持意思,但名字不同,不要混淆。


1
投票

好吧,他们看起来并不令人困惑:至少对我来说。

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

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

class TextWithHeader
{
    public final String s;
}

class TextWithoutHeader
{
    public final String s;
}

也许那时,你的TextWithHeader类甚至可以提供一种方法getTextWithoutHeader()

© www.soinside.com 2019 - 2024. All rights reserved.