Здравствуйте!
Вчера у нас была рубрика занимательный факт, где я рассказал вам об отличной рассылке о языке Python.
А сегодня мы поговорим про...
Читаемость кода.
Одно дело говорить о читаемости кода, советовать в книгах писать читаемый код, другое — встретиться с причиной всех этих советов и убедиться,что все они абсолютно верны.
Вчера во второй половине дня мне прислали тестовое задание и я, чтобы не откладывать его выполнение в долгий ящик, решил выполнить его тем же днём.
Я приступил и встретился с этим... Это было ужасным. Но обо всём по порядку.
Чтобы не выдавать, что это был за сайт, я попробую объяснить, что это за вид сайтов. Представьте интернет-магазин, у которого в каждом регионе есть свой филлиал и в зависимости от города, открывается магазин этого города, его товары, адрес, телефон и так далее. В общем же это тот же самый сайт с одинаковым везде дизайном. В нашем случае, это правда не было интернет магазином, по структуре этот портал был в разы проще.
Так уж получилось, что мне нужно было работать с кодом страницы и когда я его открыл и пригляделся, я в прямом смысле ужаснулся. Это была какая-то помойка кода. Имена классов тегов не отражали сути этих тегов, в коде творилась какая-то чехарда из элементов в разделе с именем класс был "телефон", в разделе с почтой также был класс "телефон". В один тег мог быть вложен другой тег, а он в свою очередь ещё в несколько тегов и это не имело абсолютно никакого смысла, либо у верстальщика в голове была идея сделать что-то великое, но получился какой-то абсурд, либо верстальщику обещали не заплатить за труд, а наказать за него. Я подумал, есть же ещё такие же сайты в пределах этого портала, которые должны быть одинаковыми. Сразу скажу этих минисайтов в пределах этого портала около 5000, я просмотрел штук 10 и мне хватило. На всех минисайтах стиль был "кто во что горазд", хоть сайты и были одинаковы по смыслу наполнения, все элементы в них находились каждый раз на разных местах, разными шрифтами, в разном стиле.
Как идёт поддержка таких сайтов я даже представить себе не могу, и тому, кто их поддерживает позавидовать я тоже не могу. Думаю, что сами создатели этих шедевров не смогли бы разобраться в этом, зайдя в код своего творения через несколько недель.
Пишите читаемый код.
Ребята и девчата, всё что говорится в учебниках по программированию по поводу читаемости — это не пустой звук. Это пишется не для занудства или потому что все такие правильные и прилежные. Нет. Прежде всего читаемый код вы пишете для себя. Если вы после того как написали код не можете понять, что в нём к чему, но он при этом работает — лучше исправьте его сейчас: напишите комментарии к отдельным частям кода, задокумментируйте функции. Сейчас, пока вы обучаетесь, лучше приучить к этому себя сразу. Когда пойдёте работать данная привычка лишней не окажется(даже, если вы будете делать это только для себя). В противном случае, каждое необходимое мелкое изменение в коде будет для вас пыткой.
Приятного вам обучения!
Если понравилась статья, поставьте, пожалуйста, лайк! А если вы ещё не с нами, то обязательно подписывайтесь, тут полезно и интересно.
Предыдущая статья ................................................................... Следующая статья.
