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

Question

[galithr]

Допустим есть класс позволяющий редактировать свои свойства только с помощью геттеров и сеттеров, например:

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 комменты для сеттеров и геттеров?

Comments

[Сергей delphinpro]

Мне думается так же, как и для других методов. А в чем сомнения?

[galithr]

Сергей: изменил свой вопрос с учетом Вашего коммента

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