故意拼写错误以避免保留字

我经常看到这样的代码，其中包含常见单词的故意拼写错误，无论好坏，这些单词已成为保留单词：

• klass或clazz为类：Class clazz = ThisClass.class
• kount用于计数在SQL：count(*) AS kount

我个人认为这会降低可读性。在我自己的实践中，我发现没有太多案例无法使用更好的名称- itemClass或recordTotal。

JavaDocs for Class中的示例在参数中显示了这一点：

 public <U> Class<? extends U> asSubclass(Class<U> clazz)

这是否显示合理的用例？

恕我直言，这是一个非常糟糕的主意。保留字被保留是有原因的，这样做确实会降低可读性。

我也完全同意你的第二点。命名变量class（即使您可以做到）也和命名它tmp或一样糟糕a。什么样的课？一类什么？名称应具有描述性。

Python的样式指南专门指出了这个问题，并提出了以下建议：

如果您的公共属性名称与保留关键字冲突，请在属性名称后附加一个下划线。这比缩写或拼写错误更可取。

假设它与特定语言的语义没有冲突，这似乎是一条很好的通用规则。

代码气味。

string stringVariable = "";

上面的代码告诉我有关变量预期用途的任何信息。

class Klass

同样的问题

string UserNameString = "bmackey"

上面的代码不应要求在变量名后附加关键字字符串。如果您发现自己需要通过变量名来标识类型，则您的代码太长。冷凝重构。

就个人而言，我认为这对于您的代码样式来说是一个非常有效的选择。

它们是保留字，因此编译器不必确定您的意思是语言机制还是变量。考虑到这一点，这意味着他们期望人们需要一个像保留字这样的变量。

通过与JDK 1.6 R21捆绑在一起的源代码，我发现917个“ clazz”出现。显然，他们认为这是可以接受的风格。

您的团队对此感觉如何？如果您认为这很糟糕，但是团队中的其他9个人认为这很好，那么您就必须硬着头皮接受它。只要能就什么可以，什么不可以进行交流，并且提出的问题就可以了。

您的团队对代码风格的感觉比我或其他任何人的看法更重要。这以及您可能拥有的其他任何代码样式决策都适用。

故意使用拼写错误来避免保留字是一个坏主意。

• 拼写错误很难与正确的拼写区别开，因此它们会使代码更难阅读。

• 拼写错误很难记住，因此在代码中可能会出现几种不一致的拼写错误，这使得代码更难编写和阅读。

• 保留字是指用于解决问题的语言，而不是问题本身。变量名称应指向与问题相关的概念。

因此，最好选择一个替代性的描述性名称，或者如果不存在令人满意的替代性名称，则使保留字符合以下条件：

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> benchmarkedClass = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(benchmarkedClass, benchmark.generatedMethod());
}

Class clazz闻起来像是“我没有费力去想出一个好名字”。变量总是代表某种东西，一个好名字来描述它。我拒绝想象clazz在任何情况下都可能是最好的名字。它是对类的引用-> class_reference，是对类对象的副本-> class_copy，等等。可能还会删除“ class”，仅使用描述性词，例如

java.lang.SecurityManager.checkMemberAccess(Class<?> clazz, int which)
Parameters
    clazz -- the class that reflection is to be performed on.

这里clazz是要执行检查的目标类，因此

checkMemberAccess(Class<?> target, int which)

比clazz更能描述该参数的用途。

如果他们使用变量的保留名称，则该变量的名称不正确。即使它是合法名称，例如教室软件的Class。

命名不佳的变量是思想欠佳或代码随意的迹象-提防您维护的软件中的其他陷阱。

我认为，如果谨慎且一致地使用故意拼写错误或缩写是一个好主意。

在Java中考虑：

class X { public X() { } }
X x = new X();
x.getClass;  // Wha?  How does "get" help anything?
x.class;     // Best, but requires more lexer/parser work
x.klass;     // At least as good as getClass
x.clazz;     // Same

使用拼写错误的地方是保留字显然是该工作的最佳字。有两个地方不建议您使用拼写错误。

1. 你不会想起一个好名字
2. 您只需要一个虚拟变量，并且不需要描述性名称

在第一种情况下，很明显懒惰很少是创建高质量代码的好策略。在第二种情况下，选择一个非常短的变量。那是数学家一直在做的事情，程序员是在做索引的事情。如果确实只是一个虚拟变量，没有理由将自己限制在索引上：

boolean isMyName(String testName) { return myName.equals(testName); }
boolean isMyName(String s) { return myName.equals(s); }

Date nextMeeting(Klass klass) { return /* something */ }
Date nextMeeting(Klass k) { return /* something */ }

当方法或代码的结构告诉您必须存在的内容时，使用简短的变量名不会丢失任何内容。

我已经看到了Class klass在实际使用Class类的实例进行反射时的合法用法。

我经常看到这样的代码，其中包含常见单词的故意拼写错误，无论好坏，这些单词已成为保留单词：

班级的克拉斯或克拉兹：类别clazz = ThisClass.class

SQL中的计数的kount：count（*）AS kount

我个人认为这会降低可读性。在我自己的实践中，我发现没有太多情况无法使用更好的名称-itemClass或recordTotal。

但是，这种情况太普遍了，我不禁想知道我是否是唯一的一个？任何人都可以从受尊敬的程序员那里获得任何建议甚至更好的引用建议吗？

对于局部变量和形式参数，这无关紧要。

只要没有故意误导或烦人的干扰，任何名称都可以。在您的示例中：

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> clazz = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(clazz, benchmark.generatedMethod());
}

单个局部变量是“ clazz”还是“ klass”或“ cls”还是仅仅是“ c”都没有关系。我可能只是内联表达式：

return findBenchmarkMethod(ClassUtils.loadClass(benchmark.generatedClass()),
                           benchmark.generatedMethod());

变量名称的长度应与变量的范围有关。对于使用短方法的局部变量（它们都应该短），非常短的名称就可以了。

我认为拼写错误始终是个坏主意。这对您的读者来说不是很好。我想知道的是，当我看到这个词时我是否错过了什么klass。（他们的意思是class，还是海盗？）至少对我而言，我认识到的所有拼写错误都很令人讨厌。

在极少数情况下，保留字实际上是唯一有关变量的重要信息，我将使用以下替代方法：

• 如果是函数参数，请使用aClass代替class。

• 如果是局部变量或成员变量，请使用myClass代替class。

• 如果是访问器，请使用getClass()代替class()。

当然，添加的前缀是毫无意义的，因此，只能将其用作最后的手段。但是至少它不会干扰读者的心理分析器，并且这是避免保留字的一种故障保护方法。

创造性拼写的好处之一是更好的搜索能力。我认为，对唯一的事物进行完整的代码搜索比对普通的单词进行搜索要容易得多，在普通的单词中，您经常会发现所有错误的事物，其中有1000多个错误。例如，我曾经拥有kzpg.com。谷歌现在，您只会看到一些点击。它是唯一的，因此非常容易找到。

但是从某种程度上来说，我认为这个问题不仅仅是实质性的观点。我个人是在Forth上长大的，而这全都是关于单词的，其中很多都是单词。一个人学会了变得非常有创造力，以拯救自己的手指。最后，我的来源库中大约有640,000个字符。因此，保持简短对完成工作很重要。