Size: a a a

2020 December 03

AM

Alexander Makarov in Yii Framework 3
mj4444
Вот ещё пример
   /**
    * @throws HeadersHaveBeenSentException
    * @return bool
    */
Если например я укажу только @throws, то PhpStorm ругается "Argument PHPDoc missing". Нужно указывать @return bool или нет?
Я как бы с PhpStorm согласен, либо нет коммента, либо в нём указывается всё.
Это настраивается.
источник

AM

Alexander Makarov in Yii Framework 3
источник

AM

Alexander Makarov in Yii Framework 3
> Method comment is necessary except it adds nothing to what method name and signature already has.
источник

AM

Alexander Makarov in Yii Framework 3
То есть если у нас там просто @return bool и при этом у метода и так прописано что bool, то нафиг такой коммент не нужен.
источник

AM

Alexander Makarov in Yii Framework 3
Если же там @return bool If bla-bla is alright, то уже норм.
источник

AM

Alexander Makarov in Yii Framework 3
Здесь есть новая информация, которой нет в сигнатуре.
источник

m

mj4444 in Yii Framework 3
Alexander Makarov
Это настраивается.
Понятно что настраивается. Я о том как нужно на самом деле в случаях когда у части элементов есть bla-bla, а у части нет.
источник

m

mj4444 in Yii Framework 3
Alexander Makarov
Здесь есть новая информация, которой нет в сигнатуре.
Например PhpStorm так же ругается если я в phpdoc не опишу все возможные Exception.
В коде yii3 нужно описывать все возможные Exсepton или нет?
источник

m

mj4444 in Yii Framework 3
Вот ещё пример
@param int $number1
@param int $number2 bla-bla-bla
$number1 не имеет комментария. Его нужно указывать?
источник

AM

Alexander Makarov in Yii Framework 3
mj4444
Например PhpStorm так же ругается если я в phpdoc не опишу все возможные Exception.
В коде yii3 нужно описывать все возможные Exсepton или нет?
Ну да. Нужно.
источник

AM

Alexander Makarov in Yii Framework 3
Но не все, рантайм описывать смысла особо нет.
источник

AM

Alexander Makarov in Yii Framework 3
Но можно.
источник

AM

Alexander Makarov in Yii Framework 3
mj4444
Вот ещё пример
@param int $number1
@param int $number2 bla-bla-bla
$number1 не имеет комментария. Его нужно указывать?
Если сигнатура метода такая: function bla(int $number1, int $number2), то не нужно. Он не добавляет никакой инфы вообще.
источник

AM

Alexander Makarov in Yii Framework 3
Но тут лучше добавить инфу, чем убирать.
источник

m

mj4444 in Yii Framework 3
Alexander Makarov
Но не все, рантайм описывать смысла особо нет.
В phpstorm есть правила, унаследованные от рантайм (и ещё 2 классов) он не добавляет в phpdoc.
источник

AM

Alexander Makarov in Yii Framework 3
mj4444
В phpstorm есть правила, унаследованные от рантайм (и ещё 2 классов) он не добавляет в phpdoc.
И правильно делает.
источник

m

mj4444 in Yii Framework 3
Alexander Makarov
Ну да. Нужно.
Если я добавляю в phpdoc Exception, phpstorm хочет что бы я так же добавил описание параметров и возвращаем ого типа. С этим как быть? добавлять или оставить только Exception?
источник

AM

Alexander Makarov in Yii Framework 3
mj4444
Если я добавляю в phpdoc Exception, phpstorm хочет что бы я так же добавил описание параметров и возвращаем ого типа. С этим как быть? добавлять или оставить только Exception?
Если добавлять, то с описанием.
источник

AM

Alexander Makarov in Yii Framework 3
Если без описания, то не добавлять.
источник

m

mj4444 in Yii Framework 3
Alexander Makarov
Если без описания, то не добавлять.
То есть оставлять только @throws строки?
источник