Простая, но повторяющаяся проблема именования

Question

Допустим, у нас есть метод:

  public String wishes(Date birthday) { 
          String birthayDateString = convertToString(birthay);

  ...

  }

Интересно, какое имя лучше всего дать строке под названием "birthayDateString". Эта строка представляет дату, преобразованную в текст. Я не могу назвать его «день рождения», потому что это имя уже используется. Называет ли это значение birthdayString или birthdayDateString нарушающими некоторые правила добросовестной практики соглашения об именах?

Answer 1

Это на самом деле выглядит хорошо.

Лично я бы предпочел birthdayStr - короче и точнее - сделать его одновременно осмысленным и в то же время кратким.

Уступая:

  public String wishes(Date birthday) { 
      String birthdayStr = convertToString(birthday);
      // whatever
  }

Answer 2

Называй как хочешь.

Имя переменной будет находиться в области видимости только для текущего блока метода (который должен быть достаточно маленьким, если ваш код правильно разбит / инкапсулирован).

Лично я бы пошел с birthdayStr только для ясности в этом конкретном методе.]

Я бы также прописал эти MethodNames в верхнем регистре до Wishes и ConvertToString

Answer 3

Нет, я не думаю, что вы нарушаете какие-либо стандарты "лучшей практики". В подобных случаях я часто использую имена переменных, такие как birthdayText или birthdayStr.

В целом, однако, я стараюсь сделать имена переменных как можно более значимыми - я не просто автоматически добавляю «Str» или «Text», если есть конфликт имен. Но в данном случае это просто строковое представление даты, поэтому я бы сказал, что оно достаточно значимое.