是否有变量命名约定的简明目录？

Question

多年来我遇到过许多不同风格的变量名称。

当前关于命名约定的维基百科条目相当简单......

我希望看到变量命名约定的简明目录，通过名称/描述和一些示例来识别它。

如果某个公约特别受到某个平台社区的青睐，那也值得注意。

我正在将其转变为社区 wiki，因此请为每个约定创建一个答案，并根据需要进行编辑。

Answer 1

我见过的最好的命名约定集在《Code Complete” Steve McConnell 有一个关于命名约定和大量示例的精彩部分。 他的示例贯穿了不同语言的许多“最佳实践”，但最终由开发人员、开发经理或架构师来决定具体操作。

Answer 2

PEP8 是 Python 代码的风格指南，属于标准库的一部分在Python社区中是比较有影响力的。 额外的一点是，除了涵盖 Python 标准库使用的命名约定之外，它还提供了一般命名约定的概述。

根据 PEP8：标准库中的变量、实例变量、函数和方法应该使用小写单词，并用下划线分隔以提高可读性：

foo
parse_foo
a_long_descriptive_name

为了区分名称和保留字，请附加下划线：

in_
and_
or_

弱私有名称（不由'from M import *') 以单个下划线开头。 通过名称修改强制实施隐私的名称以双下划线开头。：

_some_what_private
__a_slightly_more_private_name

Python“特殊”方法的名称以双下划线开头和结尾：

__hash__  # hash(o) = o.__hash__()
__str__   # str(o) = o.__str__()

Answer 3

Sun 在此处发布了 Java 变量名称约定列表。 该列表包括命名包、类、接口、方法、变量和常量的约定。

关于变量状态的部分

<块引用>

除了变量之外，所有实例、类和类常量都是大小写混合且首字母小写。 内部单词以大写字母开头。 变量名称不应以下划线 _ 或美元符号 $ 字符开头，即使两者都是允许的。

变量名称应该简短而有意义。 变量名的选择应该是助记性的——也就是说，旨在向不经意的观察者表明其使用的意图。 除临时“一次性”变量外，应避免使用单字符变量名。 临时变量的通用名称是 i、j、k、m 和 n（表示整数）； c、d 和 e 表示字符。

一些例子包括

int             i;
char            c;
float           myWidth;

Answer 4

无论您的命名约定是什么，它通常都不允许您轻松区分：

• 实例（通常是私有）变量
• 局部变量（用作参数或函数的本地变量）

我使用基于 不定冠词（a、an、some）用于局部变量，并且没有用于实例变量的冠词，如本问题中所述关于变量前缀。

所以一个前缀（无论是我的方式，还是列出的任何其他前缀 在这个问题中）可以是改进变量命名约定的一种方法。

我知道你的问题不限于变量，我只是想指出命名约定的那一部分。

Answer 5

有 Einar Hoest 撰写的“Java 程序员短语手册”。

他分析了方法名称的语法结构以及方法主体的结构，并收集了以下信息：

add-[名词]-* 这些方法通常具有参数并创建对象。
它们很少返回字段值。
这句话几乎出现在所有
应用程序。

等等......从数百个开源项目中收集。

有关更多背景信息，请参阅他的 SLE08 论文。