Как стать автором
Обновить

Если что-то непонятно — смотри исходники

Не понимаю, зачем тему комментариев в исходниках нужно обсуждать таким количеством букв.

Все ведь предельно просто:
  • Код читают люди. У людей есть голова. Чтобы думать.
  • Документация (Javadoc, например) обязательна, это часть Code Conventions
  • Комментарии в исходниках — признак неочевидного когда
  • Две причины портить код неочевидными вещами — производительность и внешние зависимости
  • Плохой код нужно отделять от хорошего кода
  • Если не ты автор плохого кода, то вникать в проблемы, из-за которых код стал плохим, все равно придется

Код вообще похож на шутку. Если шутка требует пояснения, то это плохая шутка для данной аудитории.

Работаю программистом в крупном производителе софта для телекомов, за полгода работы над немаленькми компонентом с кучей зависимостей от других компонент и от внешних библиотек (например, у нас аж 3 слоя интерпретации скриптов на JS, приправленные асинхронностью и многопоточностью явы) комментарии в коде не пригодились ни разу.
В заголовок я вынес универсальный рецепт одного из коллег, успешно решивший многие вопросы в рабочем чате.

Всех с пятницей и наступающим новым годом!
Теги:
Хабы:
Данная статья не подлежит комментированию, поскольку её автор ещё не является полноправным участником сообщества. Вы сможете связаться с автором только после того, как он получит приглашение от кого-либо из участников сообщества. До этого момента его username будет скрыт псевдонимом.