当逻辑选项是保留关键字时如何命名？[关闭]

有时候，某些事物（例如变量）的最合逻辑的名称是所选语言或环境中的保留关键字。当没有同等合适的同义词时，该如何命名？

我想象有针对此问题的最佳实践启发式方法。这些可以由编程语言和环境的创建者或管理者提供。例如，如果python.org（或Guido van Rossum）说了如何用Python处理它，那将是我书中的一个很好的指导原则。有关如何使用C＃处理它的MSDN链接也将很好。
另外，软件工程中主要影响者提供的指南也应该是有价值的。也许Google / Alphabet有一个不错的风格指南，可以教我们如何处理它？

这只是一个示例：在C＃语言中，“默认”是保留关键字。当我使用枚举时，我可能希望将默认值命名为“ default”（类似于“ switch”语句），但不能这样。
（C＃区分大小写，枚举常量应大写，因此“ Default”是显而易见的选择，但让我们假设当前的样式指南规定所有枚举常量都应为小写。）
我们可以考虑使用“ defaultus”一词。 ”，但这不符合“最小惊讶原则”。我们还应该考虑“标准”和“初始”，但是不幸的是，“默认”是在这种情况下准确传达其目的的词。

对于枚举选项，应使用标题大小写Default。由于C＃区分大小写，因此不会与保留关键字冲突。请参阅.net命名准则。

由于.net中的所有公共成员均应为标题大写，而所有保留名称均为小写，因此，除非使用局部变量（包括参数），否则您实际上不会遇到这种情况。而且当地人通常会使用名词或短语作为名称，因此，最自然的名称会与关键字发生冲突非常罕见。例如。defaultValue通常会比使用更自然的名字default。因此，实际上这不是一个大问题。

在C＃中，您可以使用“ @”前缀转义保留的关键字，以便将它们用作标识符（如@default）。但这仅在您确实没有其他选择的情况下才应使用，即，如果您与使用保留关键字作为标识符的第三方库进行接口。

当然，其他语言具有不同的语法和关键字，因此该问题的解决方案也不同。

SQL有很多关键字，但是简单地转义标识符（如）是非常普遍的[Table]。有些甚至对所有标识符都这样做，无论它们是否与关键字冲突。（毕竟，将来可能会引入冲突的关键字！）

Powershell（以及其他一系列脚本语言）在所有变量之前都带有$之类的符号，这意味着它们永远不会与关键字发生冲突。

Lisp根本没有关键字，至少没有传统意义上的关键字。

Python在PEP-8中有一个官方认可的约定：

始终对类方法的第一个参数使用cls。

如果函数参数的名称与保留关键字发生冲突，通常最好在其后附加一个下划线，而不要使用缩写或拼写错误。因此，class_优于clss。（也许最好通过使用同义词来避免此类冲突。）

诸如Brainfuck或Whitespace之类的某些语言完全避免定义单词，从而巧妙地避开了问题。

简而言之，您的问题没有与语言无关的答案，因为它很大程度上取决于特定语言的语法和约定。

我会附加一个下划线（default_）

优点：

• 简单
• 很明显（为什么还要加上下划线？）
• 一致的
• 易于使用
• 我知道的所有现代语言都可以使用
• 最接近逻辑选项

为什么我不喜欢其他解决方案：

代名词：

• 很难找到
• 通常含义不完全相同（细微差别）

追加/追加单词：

• 不一致（defaultValue，defaultItem）
• 冗长而又不增加可读性

更改字母（用clazz代替class）：

• 不一致（clazz，klass，klazz）

附加数字（默认值1）：

• 提出了default2的问题

追加/追加字母：

• 不明显（程序员必须猜测它是用于名称冲突的，而不是其他名称的快捷方式）

转义关键字（@default（c＃），`default`（scala））

• 仅在某些语言中可能
• 很少使用的功能，主要是为了与其他语言兼容
• 使得您的api用户很难使用（他们必须知道该怎么做并记住该怎么做）

我什么时候不使用它：

• 现有的，广泛使用的其他公约
• 我已经知道合适的同义词
• 在您的特定枚举情况下，我将遵循@JacquesB的答案

“默认”可能不是有用的枚举值。它表示一种行为，该行为可能会根据使用环境的不同而有所变化。

话虽这么说，如果您的语言区分大小写，请对该单词使用不同的大小写。（默认与默认）

或者更好的方法是，花更多的精力键入更多字母并将其命名为DefaultValue。

我强烈建议不要为了消除歧义而在本地更改命名约定（或添加无意义的字符）（就像其他帖子中所建议的那样）。如果意图不明显，则会引起混乱，并且可能会引起疑问，为什么要这样命名。没有它就可以解决。

在每种情况下，都应该可以使用具有同义含义的单词，或者使名称更具体（甚至冗长）。即使可能引入上下文重复，它也可能是更好的解决方案。

例如，假设您有一个枚举Mode应公开默认值（如您的情况）。default_mode由于重复的原因，命名似乎不是最好的，但是在传达期望的含义时避免了歧义。

您需要使用其他或修饰的单词，这很清楚。
所以这通常意味着

• 一个完全不同的词
• 前缀
• 后缀

另一个要确定的因素是如何连接多个单词，并且选项通常是

• allonewordnoseparators
• words_with_underscores或破折号（snake_case）
• 大写和可读性（CamelCase）

我的建议是使用前缀或后缀以及下划线/破折号，例如

local_default, my_default, a_default, domain_specific_default
default_local, default_me, default_a, default_domain_specific

local_default这样做的好处是所有本地人都对齐，因此可以迅速脱颖而出，但缺点是您必须先阅读第二部分才能获得唯一名称。 default_local具有相反的优势，即可以快速看到唯一的变量名，但是本地对象并不总是那么容易在视觉上分组。

我所看到的domain_specific方法的两个示例是：保留字vehicle_model代替model；room_table对于SQL表，table它是保留字。

我见过的语言或脚本使用的其他两个选项是：

• 用引号或反引号将变量名引起来，从而允许使用保留字。与此类似，我可以想象某些语言可能允许特殊字符（例如退格键）转义名称。
• 变量名称中的空格。

显然，请尽您所能避免这种情况。自1970年代末以来，我一直在编写软件，而我真的非常不得不捏造保留字的时间在10岁以下，可能接近5岁。

您可以执行许多操作，例如将第一个或最后一个字母（reservedd）加倍或添加前导或尾随下划线（reserved_）。适当的选择将在很大程度上取决于您所使用的约定，尤其是关于下划线或下划线。另外，请不要对可能被人误读的情况做一些事情（例如，使用Reserved不同于的情况reserved）。

选择了某些内容后，将其放入您的编码指南中，请确保人们了解它并确保其被一致使用。我什至甚至添加了提醒评论，因此读者不认为这是一个错字，并且知道他们会再次看到它：

int ccase;  // Name dodges a reserved word

在C＃中，可以在标识符前面加上@。这告诉编译器将名称视为标识符的名称，而不是可能的关键字。

enum @default {Sat, Sun, Mon, Tue, Wed, Thu, Fri};