Не комментируйте свой код Далеко не все комментарии бесполез | Senior Frontend - javascript, html, css
Не комментируйте свой код
Далеко не все комментарии бесполезны. Напротив, при правильном использовании они могут очень пригодиться. Но это не решение для устранения беспорядка в коде, более того: комментарии могут создать еще больше беспорядка.
Некоторые разработчики склонны больше сосредотачиваться на написании лишних комментариев, чем на рефакторинге самого кода. Вот несколько примеров комментариев, без которых вашей команде будет лучше:
Избыточные комментарии
Комментарии должны добавлять ценность или описывать логику, стоящую за кодом, а не переводить синтаксис. Если код был хорошо написан, то комментарии, описывающие его работу, не нужны.
Комментарии, вводящие в заблуждение
Автор кода в какой то момент может оставить неточный комментарий. По каким-то естественным причинам может оказаться, что комментарий больше не соответствует коду. В обоих случаях другому программисту придется дольше разбираться с тем, что происходит в коде.
Шумовые комментарии
Комментарии должны содержать новую информацию, иначе они будут просто шумом, который мы в итоге будем игнорировать. Если вы игнорируете комментарий, значит, он был вообще бесполезным и его не должно было быть.
Комментарии к замене функции или переменной
Сложная строка кода нуждается не в комментариях. Ее нужно реорганизовать или разбить на более мелкие компоненты.
Комментарии авторства
Нет необходимости засорять код маленькими строками своей подписи. Существует много инструментов управления версиями, которые очень хорошо запоминают, кто что добавил и когда.
@seniorFront
