Есть ли способ подавить "нет резюме" для методов получения и установки

Question

При документировании класса php с хорошо именованными свойствами, имеющими методы get и set для каждого свойства, генерируемый phpdoc отчет об ошибках полон ошибок, таких как:

Нет сводки для метода getFirstName ()
Нет сводки для метода setFirstName ()

за каждую собственность. Я использую шаблон по умолчанию. Если firstName уже задокументировано:

/** @var string $firstName contact's first name */
protected $firstName;

представляется излишним предоставлять сводку для методов get и set.

/**
 * @return string
 */
public function getFirstName()
{
    return $this->firstName;
}

/**
 * @param string $firstName
 */
public function setFirstName($firstName)
{
    $this->firstName = $firstName;
}

Есть ли способ использовать один из существующих тегов в phpDocumentor, чтобы избежать появления "отсутствия сводки" в отчете об ошибке? Я не смог заставить работать @inheritdoc, так как эти методы ничего не переопределяют в их базовом классе, или в некоторых случаях не было бы базового класса.

Я просмотрел шаблонов docblock /**#@+ и /**#@-*/ тегов, но не смог заставить их применить сводку для группы вложенных методов. Я попытался только с кратким резюме, а также с длинным резюме.

Если нет, то какой СУХОЙ способ документировать такие классы?

Answer 1

Нет, в настоящее время нет способа подавить это.

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

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