【发布时间】:2011-12-27 15:51:05
【问题描述】:
我的函数在概念上都返回相同的东西,但结果可以采用不同的形式:
function GetThingy()
有四个不同的函数,每个函数可以返回不同的东西:
-
0.071(float值表示增加了 7.1%) -
7.1(float值表示增加了 7.1%) -
1.071(float值表示增加了 7.1%) -
"7.1%"(string值代表 7.1% 的百分比)
我可以使用哪些术语来帮助记录这些函数的返回值?
我想出了自己的术语:
-
fraction:一个fraction;该值被理解为介于 0..1 之间(例如,
0.07代表 7%) -
百分比:每百个值;其中值被理解为介于 0..100 之间(例如,
7代表 7%)注意:这与 分数 形成对比,它是 per-one,而不是超过一百分 -
因素:A scale factor, that can be used to directly multiply;理解为相当于1+fraction(例如
1.07表示增加7%) -
percentage:一个字符串,包含实际的百分比字符(即%),适合显示给用户,或喜欢本地化文本的情况(例如,
"7%"意味着 7%)
所以将我自己的命名方案应用于函数:
-
GetThingyFraction()= 0.071 -
GetThingyPercent()= 7.1 -
GetThingyFactor()= 1.071 -
GetThingyPercentage()= "7.1%"
你说什么?
【问题讨论】:
-
我强烈建议不要使用四个基本上都做同样事情的函数。相反,有一个 getter(总是返回一个“分数”),然后是可以从一种格式转换为另一种格式的辅助函数。
-
@duffymo 我既不寻求验证,也不要求采用。我要求正确的条款。如果我谈论使用 SHA1 来“加密”我的密码,我相信我会听到正确的术语。
-
我不会将帮助命名方法称为编程问题。使用内联文档来描述函数。
-
也许是English.S.E的人。对你没有大写“I”感到愤怒。
-
@BalamBalam:它们都返回相同的概念,只是格式不同。
标签: language-agnostic naming-conventions