变量的人类可读版本的命名约定
Naming convention for human readable version of variable
我有一个 class,它有一个整数 属性 difficulty
。该值存储为 1
和 3
之间的数字,并显示为 "Beginner"
、"Intermediate"
或 "Expert"
.
我有一种方法可以将整数转换为这些更易于阅读的标签之一,但我无法为该方法想出一个好名字。我在变量名前加上 hr_
前缀,例如 hr_difficulty
,但我想知道是否有更好的约定。
为了很好地适应代码的其他部分,特别是如果它是一个方法调用,我使用词缀而不是前缀,例如 difficulty_s
。这意味着你有 difficulty
,然后对它做了一些事情,这对应于 _s
部分。 hr
或 "human readable" 对我来说听起来太具体了。我认为 s
对于 "string" 就足够了。
我觉得difficulty_in_words
会好一些,因为它天生就比较难。
我会用这个签名创建一个通用方法:
human_option_name(:difficulty)[difficulty]
因为您可能无论如何都需要所有困难的列表(例如在 select 选项中)并且稍后您可能需要包括翻译。该命名类似于已经存在的方法 human_attribute_name
我有一个 class,它有一个整数 属性 difficulty
。该值存储为 1
和 3
之间的数字,并显示为 "Beginner"
、"Intermediate"
或 "Expert"
.
我有一种方法可以将整数转换为这些更易于阅读的标签之一,但我无法为该方法想出一个好名字。我在变量名前加上 hr_
前缀,例如 hr_difficulty
,但我想知道是否有更好的约定。
为了很好地适应代码的其他部分,特别是如果它是一个方法调用,我使用词缀而不是前缀,例如 difficulty_s
。这意味着你有 difficulty
,然后对它做了一些事情,这对应于 _s
部分。 hr
或 "human readable" 对我来说听起来太具体了。我认为 s
对于 "string" 就足够了。
我觉得difficulty_in_words
会好一些,因为它天生就比较难。
我会用这个签名创建一个通用方法:
human_option_name(:difficulty)[difficulty]
因为您可能无论如何都需要所有困难的列表(例如在 select 选项中)并且稍后您可能需要包括翻译。该命名类似于已经存在的方法 human_attribute_name