В моей программе у каждой строки кода есть комментарий. Что не так?
Я хочу, чтобы любой мог понять этот код. Его так проще читать и легче поддерживать.
Илья
С такими комментариями ряд проблем: с информативностью, актуальностью и размером.
У таких комментариев проблема с информативностью. Большая часть таких комментариев – перевод мыслей с Питона на русский. В них нет новой информации. Получается, что время на чтение комментария потрачено зря.
У таких комментариев проблема с актуальностью. Когда нужно поправить код, руки редко доходят до исправления комментариев. Это приводит к тому, что комментарии не соответствуют коду или к тому, что исправление затягивается: любую мысль нужно записывать дважды. И то и другое приводит к лишней работе с той же целью.
Такие комментарии увеличивают размер. Представь простой, лаконичный код, который умещается в 80 символов в ширину и в экран в длину. А теперь представь этот же код, но с комментариями. В нём уже стабильные 120 символов в ширину и три экрана в длину. У тебя в команде собрались любители скроллить? Едва ли.
Перекомментированный код не поможет начинающим разработчикам и новичкам в проекте: им нужно читать вдвое больше кода, ломать голову над неактуальными комментариями и скроллить, скроллить. А ведь могли бы сделать что-нибудь полезное.
Лишние комментарии – как телепузики в операционной. Нелепые толстые отвлекающие чуваки.
Комментарии – как ниндзя. Появляются редко, естественно и очень в тему.
Попробуйте бесплатные уроки по Python
Получите крутое код-ревью от практикующих программистов с разбором ошибок и рекомендациями, на что обратить внимание — бесплатно.
Переходите на страницу учебных модулей «Девмана» и выбирайте тему.