#18. Генерация док-блоков или php-doc блоков в PHP Storm

PHP Storm имеет одну прекрасную функцию для комментирования кода — это автоматическая генерация phpdoc (или docblocks).

Чтобы сгенерировать phpdoc нужно поместить курсор на метод и нажать Alt+Enter чтобы вызвать меню действий, затем выбрать Generate PHPDoc for function.

PhpStorm добавит @params для каждого параметра функции и включит их типы данных из предоставленных типов возле параметров. Он также добавит @return, если указан тип возвращаемого значения или если функция возвращает ненулевые значения.

Если PhpStorm не сможет определить тип данных для @param, будет использован тип данных mixed или вообще ничего не будет указано. В таких ситуациях не забудьте указать тип данных самостоятельно или исправить его.

PhpStorm также может обновить phpdoc если функция изменится, просто вызовите меню действий еще раз и выберите Update PHPDoc Comment