@galithr

Как правильно писать PHPDoc для сеттеров и геттеров?

Допустим есть класс позволяющий редактировать свои свойства только с помощью геттеров и сеттеров, например:
class MyClass
{
    /**
     * @var string Название контроллера отвечающего за обработку запроса
     */
    private $controllerName;

    /**
     * Установка названия контроллера отвечающего за обработку запроса
     *
     * @param string Название контроллера
     */
    public function setСontrollerName($value)
    {
        $this->controllerName = $value;
    }

    /**
     * Получение названия контроллера отвечающего за обработку запроса
     *
     * @return string Название контроллера
     */
    public function getСontrollerName()
    {
        return $this->controllerName;
    }
}

Напрягает то что слишком много комментариев по смыслу дублирующих друг друга. Как правильно в таком случае писать PHPDoc комменты для сеттеров и геттеров?
  • Вопрос задан
  • 568 просмотров
Решения вопроса 1
Можно ссылаться на свойство объекта, на вашем примере:
class MyClass
{
    /**
     * @var string Название контроллера отвечающего за обработку запроса
     */
    private $controllerName;

    /**
     * @see MyClass::$controllerName
     * @param string Название контроллера
     */
    public function setСontrollerName($value)
    {
        $this->controllerName = $value;
    }

    /**
     * @see MyClass::$controllerName
     * @return string Название контроллера
     */
    public function getСontrollerName()
    {
        return $this->controllerName;
    }
}
Ответ написан
Комментировать
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы
19 апр. 2024, в 11:14
65000 руб./за проект
19 апр. 2024, в 11:08
5000 руб./за проект
19 апр. 2024, в 10:59
150000 руб./за проект