人类可读变量版本的命名约定

时间:2015-02-21 20:02:28

标签: ruby naming-conventions

我有一个具有整数属性difficulty的类。该值存储为13之间的数字,并显示为"Beginner""Intermediate""Expert"

我有一个方法可以将整数转换为这些更易读的标签之一,但是我无法想出这个方法的好名字。我将hr_加上变量的名称,例如hr_difficulty,但我想知道是否有更好的约定。

3 个答案:

答案 0 :(得分:1)

为了更好地适应代码的其他部分,特别是如果它是一个方法调用它会是什么样子,我使用词缀,而不是前缀,例如difficulty_s。这意味着你有difficulty,然后对它做了一些事情,它对应于_s部分。 hr或“人类可读”听起来对我来说太具体了。我认为s对于“字符串”就足够了。

答案 1 :(得分:1)

我将使用此签名创建一个通用方法:

human_option_name(:difficulty)[difficulty]

因为您可能需要所有defficulties的列表(例如在选择选项中),您可能需要稍后包含翻译。该命名类似于现有方法human_attribute_name

答案 2 :(得分:0)

我认为difficulty_in_words会更好,因为它自然难以言语。