Должен ли я положить @throws в документах? - PullRequest
0 голосов
/ 02 мая 2018

Должен ли я поставить @throws в метод docs, когда это исключение может быть вызвано из другого метода, который вызывается в моем методе?

Пример

class ClassOne{
    /**
     * @throws MyException
     *
     * @return void
     */
    public function aMethod()
    {
        if(true)
        {
            throw new MyException();
        }
    }
}

class ClassTwo{
    /**
     * @throws MyException           // should I document this line?
     *
     * @return void
     */
    public function myMethod()
    {
        $classOne = new ClassOne();

        $classOne->aMethod();
    }
}

При создании DocBlock с использованием PHPStorm он не видит исключения из ClassOne и не помещает строку @throws в документы ClassTwo.

1 Ответ

0 голосов
/ 02 мая 2018

Если вы не поймаете исключение, вы будете использовать нотацию PHP-Doc, если хотите написать чистый код. Следующим, кто использует ваш класс get, является сообщение, информирующее IDE о том, что он должен перехватить исключение или передать его также. Для запуска вашего кода это не имеет значения.

...