Термин процент, процент, дробь, коэффициент масштабирования? - PullRequest
3 голосов
/ 27 декабря 2011

у меня есть функции, которые концептуально все возвращают одно и то же, но результат может принимать разные формы:

function GetThingy()

Существует четыре разные функции, каждая из которых может возвращать разные вещи:

  • 0.071 (значение float представляет увеличение на 7,1%)
  • 7.1 (значение float представляет увеличение на 7,1%)
  • 1.071 (float значение, представляющее увеличение на 7,1%)
  • "7.1%" (string значение, представляющее процент в 7,1%)

Что термины могу ли я использовать, чтобы помочь документировать эти функции, возвращающие значения?

Я пришел с собственной терминологией:

  • дробь : A фракция одного;где значение понимается в диапазоне от 0,1 (например, 0.07 представляет 7%)
  • процентов : значение на сотню ;где значение понимается как 0..100 (например, 7 представляет 7%) Примечание : Это контрастирует с дробью , с является на единицу, а не на-сот
  • коэффициент : A масштабный коэффициент , который можно использовать для прямого умножения ;считается эквивалентным 1 + фракция (например, 1.07 подразумевает увеличение на 7%)
  • процент : строка , которая содержитфактический символ процента (т.е. % ), подходящий для отображения пользователю, или случаи, когда предпочитают локализованный текст (например, "7%" подразумевает 7%)

Таким образом, применяя мою собственную схему именования к функциям:

  • GetThingyFraction() = 0.071
  • GetThingyPercent() = 7.1
  • GetThingyFactor() = 1.071
  • GetThingyPercentage() = "7,1%"

Что вы скажете?

Примечание: Я задал этот вопрос на English.stackexchange.com , но получил отрицательные отзывы без объяснения причин.Очевидно, им не нравятся связанные с программированием английские вопросы.

Будем надеяться, что stackoverflow не ненавидит связанные с английским языком вопросы программирования. Обновление : Похоже, SO ненавидит вопросы программирования на английском языке.

enter image description here "Как вам это нравится? Даже среди неудачников вынеудачники. "

Ответы [ 3 ]

1 голос
/ 27 декабря 2011

Я бы сказал, что вы только что получили его, но я бы добавил слово «Увеличить» в некоторых местах и ​​поместил ваши примеры в документацию / комментарии:.например, «7,1%» означает увеличение на 7,1%]

1 голос
/ 27 декабря 2011

Не совсем уверен, что на этот вопрос есть «ответ», но наименование функций, как вы продемонстрировали, позволяет потребителю очень легко понять, что он получает. Мне также нравятся выбранные вами условия.

Планируете ли вы реализовать все четыре (или n) разновидности каждой функции или это строго вопрос именования, когда разные операции обрабатывают результат по-разному?

Я не очень уверен насчет утилиты "процентной" версии. Обычно создание строк для пользовательского интерфейса сообщений должно выполняться в презентации, а не в вычислениях. Презентация будет определять, сколько знаков после запятой, «%» против «pct» против «процентов» и т. Д.

0 голосов
/ 27 декабря 2011

Даже если ваш тег не зависит от языка, я предполагаю, что вы пишете на современном языке объектно-ориентированного программирования.

Если у вас есть класс Thingy с объектом thingy, который имеет частную дробь, то вы можете разрешить публичный доступ с помощью таких методов:

  • double thingy.asFractionIncrease
  • double thingy.asPercentIncrease
  • double thingy.asFactor
  • String thingy.asPercentIncreaseString

P.S. Я собираюсь объявить ваши EL & U сообщения. С этого момента это вернет вас к 0, и вы будете иметь чистый позитив на репутацию

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...