felony13twelve
@felony13twelve

Когда нужно писать phpdoc?

Здравствуйте! Задался таким вопрос, когда нужно писать phpdoc комментарии? Врятле же их нужно писать в каждом методе. Допустим у меня есть класс View.php нужно ли в нём писать эти комментарии?
  • Вопрос задан
  • 96 просмотров
Пригласить эксперта
Ответы на вопрос 1
delphinpro
@delphinpro
frontend developer
Для начала нужно понять, что это не комментарии, а документация, встроенная в код.

Если вы собираетесь генерировать потом документациию по phpdoc, то однозначно нужно описывать каждый метод и каждое поле, а также функции и константы.

Кроме того, phpdoc используются продвинутыми IDE для автозавершения кода.
Если вам phpdoc нужны только для автозавершения, то тут нужно учесть, что современный php уже и так позволяет указывать типы параметров и возвращаемых значений. Подобные блоки комментариев чаще всего будут излишними. Однако не всегда используется строгая типизация. Особенно в возвращаемых значениях.
В этом случае полезно бывает указать несколько возвращаемых типов в doc-блоке, чтобы IDE смогла подсказывать все имеющиеся методы возвращенного объекта.

Итого: для ведения документации описываем всё, для автозавершения в IDE пишем выборочно. Остальное по вашему желанию или по требованию работодателя/руководителя проекта.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы