Как не нужно писать комментарии в коде, или борьба за культуру и язык

в 20:52, , рубрики: Веб-разработка, управление проектами

Как кто-то выразился, «В человеке все должно быть прекрасно». Перефразируя, скажем — «В коде все должно быть прекрасно — и имена, и комментарии».
Я глубоко убежден, что человека и коллектив характеризуют не столько показные, яркие вещи, как неприметные или скрытые от посторонних глаз мелочи.
Комментарии или неявные особенности кода обычно не видны заказчику — там зачем себя утруждать? А можно и вообще повеселиться в коде от души.
За последние полгода в качестве побочной деятельности мне довелось править ряд веб-проектов, сделанных различными студиями.

Пусть простит меня администрация Хабра за содержимое приведенных цитат из кода и комментариев, и пусть будет стыдно тем, кто это писал.

Самое частое и простое — комментарий просто повторяет имя метода/свойства/переменной. Вот пример (самописная CMS)

Как не нужно писать комментарии в коде, или борьба за культуру и язык

Простите великодушно, на кой такой комментарий? Я умею читать, в том числе мне знакомы английские буквы, и слово auth мне все уже сказало.

Но это — простая, на 7 строк функция, разобраться в ней труда не составляет. Гораздо веселее, когда такой же комментарий к методу на пару экранов (внутри метода никаких дополнительных комментариев, разумеется, нет).

Но это — мелочи. Я вдруг убедился, что не знаю самых простых вещей. И вы, уважаемые читатели, тоже не знаете.
Вот, например, что такое рекурсия? То, что вы думаете — это совсем не то. Вот ответ из комментариев в коде одного из проектов:

Как не нужно писать комментарии в коде, или борьба за культуру и язык

Ну то есть рекурсия — это п..., ну тот самый.

Вы, наверное, думаете, что знаете, что такое SEO? Конечно не знаете, зато мы можем почерпнуть ответ на этот вопрос опять же в комментариях:

Как не нужно писать комментарии в коде, или борьба за культуру и язык

Одним словом, SEO — это вот она самая, указанная в комментарии.

А умеете ли вы, уважаемые программисты, загружать на сервер изображения? Наверное да, но скорее всего неправильно.
Есть способ горадзо лучше, он так и называется «о… ый способ»:

Как не нужно писать комментарии в коде, или борьба за культуру и язык

Но это — ерунда. Когда надоедают такие вот комменты, можно и веселее устроить.
Можно ли обрабатывать в коде части человеческого тела? Конечно можно, ну не все конечно, печень и мозг вряд ли кого-то заинтересует, но кое-то можно и обработать:

Как не нужно писать комментарии в коде, или борьба за культуру и язык

Это безусловно предмет гордости разработчиков. Теперь они могут со уверенностью говорить, что у них самый х… код в мире.

Я еще раз приношу глубочайшие извинения аудитории за приведенные выше цитаты. Мне — грустно и стыдно за своих коллег.
Господа программисты, имеющие склонность к подобным комментариям и коду, ваш код — ваше лицо, ваши комментарии — ваше лицо, и будьте уверены, что когда-нибудь и ваш код, и ваши комментарии кто-то будет читать и прорабатывать.

Давайте уважать и ценить друг друга!

Автор: konst20

* - обязательные к заполнению поля