Первая часть лежит здесь.
В прошлой статье я упомянул, что код должен быть хорошо комментирован. Зачем и как это делать.
Сначала зачем. Казалось бы, что может быть понятнее своего кода. Во-первых, вдруг с этим кодом потом будет работать другой программист. Во-вторых, через полгода вы начисто забудете как ваш собственный код работает. У меня недавно был случай, когда другому программисту, который работает в одной команде со мной пришлось править мою программу. А я не смог ему ничего сказать о том, как моя программа работает, поскольку под рукой не было компьютера.
Итак, комментирование. Комментарии бывают двух типов - однострочные и многострочные. Вот пример:
То, что выделено зеленым цветом и есть комментарии. В звездочки заключен многострочный комментарий, однострочный начинается с //. Также язык PHP позволяет для однострочного комментария использовать решетку.
Чем больше комментариев, тем лучше. Очень хорошо, если в начале каждого файла в проекте будет написано, за что отвечает этот файл. Также очень неплохо сопроводить, к примеру, скрипт, короткой справкой о данных, которые он может требовать:
Точно так же очень неплохо комментировать окончание длинного блока:
Для начинающих: Почти во всех популярных языках однострочный комментарий можно добавить при помощи двойного слэша (//). Также в С-подобных языках (C/C++, PHP, JavaScript) работает решетка. Многострочный комментарий можно добавить в большинстве языков при помощи конструкции /*текст комментария*/. В Delphi этот способ не работает, там для многострочного комментария надо заключить текст в фигурные скобки. Особняком стоит язык HTML. Там комментарии можно добавлять единственным способом:
<!--Текст комментария-->. Такой комментарий может быть многострочным. Кстати, небольшой лайфхак: чтобы временно выключить какой-нибудь участок кода, его достаточно закомментировать.
Теперь о константах. В программировании по традиции константы записываются прописными буквами: MY_CONST. Если вы хотите, чтобы ваш код был хорошо читаемым, придерживайтесь этого правила. Кстати, язык PHP имеет возможность сделать название константы регистрозависимым или нет:
define("WORK", true, true);//Регистрозависимая
define("WORK", true, false);//Регистронезависимая
Теперь о длинных строках. Кстати, я часто тоже этим страдаю. До того неохота переносить одну инструкцию на новую строку. Этот пример придется развернуть, а то мало что видно:
Сами видите, строки настолько длинные, что они за экран уходят. Серая полоска справа - это полоса прокрутки моего веб-редактора. А сами эти строки представляют собой очень длинный запрос к серверу PostgreSQL. И так уже на пять строк разбил, а они все равно не влезают по длине. Это - пример плохого кода. Действительно, большинство интерпретаторов и компиляторов полностью игнорируют переносы строк. Для них инструкция кончается там где стоит оператор конца строки (чаще всего точка с запятой). Так что не надо бояться переносить код на новую строку.
Буду очень рад вашим вопросам и комментариям.
Спасибо, что дочитали мою статью до конца. Если она вам понравилась, поставьте, пожалуйста, лайк. Также я буду рад, если вы подпишетесь на мой канал. Всегда рад прочитать ваши комментарии, ответить на вопросы и учесть ваши пожелания и предложения. До новых встреч!
