Предупреждение BooleanGetMethodName в phpmd

Question

Я генерирую свои сущности, используя отображение доктрин в symfony2, и получаю этот код:

/**
 * Get active
 *
 * @return boolean
 */
public function getActive() {
    return $this->active;
}

Используя плагин jenkins и PMD, они выдают предупреждения BooleanGetMethodName и предполагают, что поскольку функция getActive возвращает логическое значение, ее следует переименовать в isActive или hasActive.

У меня много файлов с этим предупреждением. Это хорошо, чтобы подавить предупреждения? Если да, то как? Или я должен заменить все имена функций, возвращающие логическое значение в сущности symfony2, чтобы следовать правилу jenkins и PMD?

Answer 1

Под PMD вы имеете в виду PHP Mess Detector?

Если это так, то, поскольку у вас есть настройка с Jenkins и PHP Mess Detector, я предполагаю, что вы действительно заботитесь о запахах кода и удобочитаемости.

Имея это в виду, мой совет вам: переименуйте все ваши логические методы, чтобы следовать isSomething() или же hasSomething() конвенций.

Однако важно заметить, какой кодекс вы придерживаетесь.

Это очень просто и быстро достичь, и даст вам много преимуществ, таких как:

• Возможные ошибки. Ошибки не всегда являются неправильно написанным кодом. Часто плохие условия или плохое управление областью видимости могут приводить к довольно трудным поискам ошибок.

• Субоптимальный код. Плохо выглядящий код может и, скорее всего, будет трудным для чтения. Это неоптимальный код.

• Слишком сложные выражения

• Неиспользуемые параметры, методы или свойства