How to write PHPDoc for setters and getters?

Question

PHP

Suppose there is a class that allows you to edit its properties only with the help of getters and setters, for example:

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;
    }
}

It's annoying that there are too many comments duplicating each other in meaning. What is the correct way to write PHPDoc comments for setters and getters in this case?

Answer 1

You can refer to an object property, in your example:

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;
    }
}