选择合适的名字

时间:2011-03-03 06:20:19

标签: naming-conventions

我理解选择一个能够在任何可能的情况下反映您的意图的适当名称以及它如何影响您的代码质量是多么重要。

例如,下面是java.math.BigDecimal中的一些方法,我认为它们有一个有趣的参数名称:

BigDecimal add(BigDecimal augend);
BigDecimal divide(BigDecimal divisor, int scale, RoundingMode roundingMode);
BigDecimal multiply(BigDecimal multiplicand);
BigDecimal subtract(BigDecimal subtrahend);

这些方法总是让我意识到知道一些特定的符号和术语对于改进你的代码是一个很大的帮助,因此我认为如果我更好地了解它们会很好。

最近我发现a really good website为您提供了数学中常用术语的列表,我想知道是否有任何类似的资源(无论是在网络,物理或与编程相关的任何其他领域)都可以提高你作为程序员的词汇量?

请注意,我在这里所指的不是编码标准,例如Zend Naming Conventions

2 个答案:

答案 0 :(得分:1)

我发现Wikipedia是一个很好的资源。

例如,当我需要一个变量来存储ampm时,我之前称之为ampm

不久前,I looked into it,现在将其命名为meridiem

答案 1 :(得分:0)

我会说有多个字段的词汇表可能有助于找到好的术语,但一般来说,这也是你的团队为自己设定的经验和惯例的问题。

命名问题是其他人读名字可能不知道如何解释它,因此你至少应该添加一个注释来解释类/字段/方法的含义。

除此之外,我建议根据用途或使用的算法命名方法,例如: sortquicksort。如果您从特定区域实施算法,您应该熟悉该区域或至少该算法,从而减少命名问题。 (例如:如果我实现了一个计算两个字符串的levenshtein distance的方法,我会将方法命名为int calcLevenshtein(String arg1, String arg2))。