Каковы преимущества префикса имен параметров функции с p *?

Я часто вижу проекты (в Java-проектах и ​​командах, использующих Eclipse), с которыми префиксные параметры функции p.

Например

public void filter (Result pResult) ...

Лично я не вижу в этом никакой пользы, но хотел бы знать, в чем причина. Лучшее объяснение, которое я слышал, состоит в том, что оно состоит в том, чтобы различать имена идентичных именованных полей. У меня есть проблемы с этим объяснением, но я могу понять суть.

Практика добавления значимых префиксов к символам, такая как широко известная венгерская нотация , восходит к временам, когда IDE не существовали или были слишком примитивными. Сегодня, когда найти точку объявления можно одним щелчком мыши, нет смысла портить самую ценную часть имени, первые несколько букв, назначая общий префикс.

Как вы подозреваете, это делается для того, чтобы избежать конфликтов имен между именем параметра и именами членов или локальных переменных. Переменные-члены иногда получают префикс по той же причине (например, m_result). Лично я предпочитаю просто использовать thisпрефикс для переменных-членов, если есть конфликт имен. Он встроен в язык, и все уже знают, что это значит.

Я использую префикс параметра только тогда, когда параметр предназначен для назначения переменной-члену, такой как конструктор или установщик.

Paint (newColor) {
  color = newColor;
}

Я считаю, что использование другого имени переменной более ослепительно очевидно, чем использование префикса «this».

В других ситуациях я избегаю использования параметра, который можно легко спутать с переменной-членом.

Если метод или класс настолько велики, что трудно сказать, что означают переменные, реальное решение состоит в том, чтобы разбить их на более мелкие методы / классы. Использование префиксов - это решение, которое помогает решить основную проблему.

Если вы создадите стандарт для использования «p» в качестве префикса для каждого имени параметра метода, вы можете легко распознать параметры метода в остальной части тела метода.

Это экономит ваше время, чтобы найти параметры метода. Вы можете легко отладить свой код.

Коротко. Эта практика затрудняет чтение кода.

Долго - я буду утверждать, что это плохая практика, используемая только для поддержки других плохих практик. Давайте рассмотрим несколько причин, по которым использование таких префиксов может считаться полезным:

• Как избежать коллизий в именах переменных

  • Ваши имена параметров выражают точно, что параметры? Если у вас есть поле параметра и класса, которые «абсолютно одинаковы», вам не нужен параметр.
  • В этом случае имеет смысл использовать префиксы для конструкторов классов, например, новый префикс *, описанный в ответе Аарона. Это также может быть полезно для методов установки, например

  public void setHeight(int newHeight) { this.height = newHeight; }

• Методы принимают много параметров, объявляют много переменных, и мы можем легко забыть, какой из них является параметром.

  • Как описано выше - проблема заключается в количестве переменных.
  • Программа, вероятно, не очень хорошо структурирована. Проверьте, все ли переменные являются «независимыми» - возможно, они должны быть организованы в структуры или классы. Возможно, весь расчет или процесс должен быть заключен в отдельный класс, чтобы оперировать таким количеством переменных.
  • Даже если вам нужно такое количество переменных - они должны использовать значимые имена, а префикс стоит между вами и значимой частью.
• Методы очень длинные, и вам нужно использовать префиксы для отслеживания того, что является параметром.
  • Проблема заключается в длине методов - если программа написана хорошо, вы всегда должны видеть заголовок метода и все его тело на одном экране.
  • Попробуйте разделить метод на более мелкие блоки.

За исключением некоторых особых случаев, добавление префиксов параметров только помогает с симптомами и не решает реальных проблем.

Я фанат iParam для входных и oParam для выходных параметров. Я бы сказал cParam за изменения, но это не приемлемо