Написанием кода занимается далеко не один разработчик, это совместная работа нескольких команд, а порой и целых подразделений (и это еще не упоминая о смене кадров). Код может жить в компании годами и переиспользоваться в новых продуктах.
По этим причинам важно, чтобы любой кусок кода, который может вызвать вопросы у стороннего читателя, был объяснен его автором. Для этого разработчики оставляют в коде комментарии. Как правило, они абсолютно безвредны для кода, почти незаметны и никак не влияют на компиляцию.
При этом комментарии помогают не только сохранить знания внутри компании, упростить понимание кода и намного быстрее производить дебаггинг, но и порой просто повеселить его читателя.
Под катом собрали и пояснили 13 примеров полезных и забавных комментариев, которые оставили наши коллеги в исходниках продуктов Content AI.
Оговариваем ожидание статуса задачи
Поясняем, почему выбрано именно такое решение для связи разных модулей в коде
Уточняем про Race condition в списке задач при обработке документов
Говорим про парсинг ответа сервиса обработки документов
Уточняем про парсинг ответа Active Directory
Поясняем хитрое извлечение параметров регулярного выражения через рефлекшн
Объясняем, что сейчас произойдет в коде
Уточняем размер батча задач при обработке документов, используя аллюзию на слова Билла Гейтса про то, что «640 КБ должно хватить всем»
Рассказываем про ветку транслятора запросов из пользовательского языка запросов в язык запросов ElasticSearch в случае отсутствия пользовательского словаря синонимов
Соглашаемся, что это ту мач
Когда код передавался заказчику, его перевели на английский язык, тем самым изменив «предназначение» – теперь он был написан во имя «славы»: This code was specifically written for glory
Речь о коде «аварийной» кодировки в PDF. Под «*опой» имелся в виду «аварийный» вариант развития событий
Прим. редакции: этот комментарий показался нам самым смешным.
NB! Мнение непросвещенной редакции может не совпадать с мнением разработчиков.
Делитесь в комментариях своими нужными или смешными пасхалками в коде.
