Комментарии в коде Однажды на собеседовании мне сказали, что | Mobile Pet

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

Однажды на собеседовании мне сказали, что от меня нужен пример моего кода, чтобы посмотреть, какие я пишу комментарии. Пример у меня, конечно, был на гитхабе, но озвученный повод показать его меня слегка удивил. Так ли важны комментарии в коде? И можно ли по их наличию или качеству что-то вразумительное сказать о скиллах разработчика? Давайте разбираться.

Комментарии делятся на 2 типа – документирующие и поясняющие. Документирующие в основном пишутся при разработке библиотек и фреймворков. Их наличие позволяет программистам, использующим код, понять назначение программных сущностей – классов, переменных, функций и их параметров. Поясняющие пишутся для тех, кто будет поддерживать код в дальнейшем. Их цель – помочь разобраться в коде, алгоритмах и уменьшить значение «WTF в минуту».

Я хорошо отношусь к документированному коду и уместным пояснениям, но плохо к обилию ненужных комментов, шапкам файлов с датой, данными об авторе и прочим, и еще хуже – к закомменченому коду. Вместо добавления текста описания работы функции можно просто подобрать ей подходящее описательное название или разбить на более простые функции. Наименования сущностей должны говорить сами за себя, чтобы код хорошо читался и без дополнительных пояснений. Шапки файлов занимают лишнее место и дублируют информацию из системы контроля версий. Закомменченый код удаляйте сразу, это мусор в проекте. Если боитесь, что потеряете кусок кода, который может вам пригодиться, снова вспомните про git.

В итоге по комментариям или по их отсутствию все-таки можно судить о чистоте кода. Эта информация не будет значимой характеристикой навыков разработчика, но на неё однозначно можно обратить внимание.
#development #management