[PHP] Комментарии в коде

Я не претендую быть истиной в последней инстанции, если я где-то не прав, прошу поправить... Ведь все мы учимся

[PHP] Комментарии в коде

писал/рукожопил/копипастил сам - тег мое

6
махровый разработчик
Автор поста оценил этот комментарий
Если код нуждается в комментариях, наверное он просто плохо написан. Зачем комментировать регулярку, когда можно правильно назвать переменную с ней? Зачем комментировать каждый метод когда можно дать адекватное имя? Единственное где нужны комментарии - объяснить ПОЧЕМУ именно такой алгоритм действий выбран или ЗАЧЕМ используется метод.
Ах, да! Это ведь не типизированный php - тогда можно добавлять коммент с указанием типа возвращаемого функцией результата и тип пропертей/переменных, всё что нужно чтобы работал автокомплит.
Остальные комменты превращаются в шум.

PS в крупных, огромных проектах ещё нужны комментарии к публичному АПИ со всеми его java/php/ng/{любой другой язык} docs.

Темы

Политика

Теги

Популярные авторы

Сообщества

18+

Теги

Популярные авторы

Сообщества

Игры

Теги

Популярные авторы

Сообщества

Юмор

Теги

Популярные авторы

Сообщества

Отношения

Теги

Популярные авторы

Сообщества

Здоровье

Теги

Популярные авторы

Сообщества

Путешествия

Теги

Популярные авторы

Сообщества

Спорт

Теги

Популярные авторы

Сообщества

Хобби

Теги

Популярные авторы

Сообщества

Сервис

Теги

Популярные авторы

Сообщества

Природа

Теги

Популярные авторы

Сообщества

Бизнес

Теги

Популярные авторы

Сообщества

Транспорт

Теги

Популярные авторы

Сообщества

Общение

Теги

Популярные авторы

Сообщества

Юриспруденция

Теги

Популярные авторы

Сообщества

Наука

Теги

Популярные авторы

Сообщества

IT

Теги

Популярные авторы

Сообщества

Животные

Теги

Популярные авторы

Сообщества

Кино и сериалы

Теги

Популярные авторы

Сообщества

Экономика

Теги

Популярные авторы

Сообщества

Кулинария

Теги

Популярные авторы

Сообщества

История

Теги

Популярные авторы

Сообщества

Недвижимость и ремонт

Теги

Популярные авторы

Сообщества