Памятка программисту

Каждый программист имеет свой стиль и характер кода. Программистов можно группировать по манерам, стилю, уровню и многим другим составляющим. Однако, есть определенная база рекомендаций, при соблюдении которых, ваш код будет понятным и читабельным для других программистов. Важно понимать, что код, написанный вами сегодня, может подлежать редактированию или дополнению другими программистами. В связи с этим нужно придерживаться определенных правил, чтобы открывший ваш код программист восхищался им, а не наоборот. И поверьте, совершенно не важно какой у вас уровень знаний. На всех уровнях есть качественный и читабельный код и есть что-то вроде набора символов, перемешанных в блендере.

Выбирайте смысловые переменные

Многие программисты пренебрегают этим и называют переменные, вовсе не имеющие отношения к логике кода. Или же устанавливают переменные по типу $a, $b практически во всем коде. Смысловые переменные придают читабельность коду и делают его быстровоспринимаемым. При чтении кода, программист обычно сам интерпретирует его в своей голове и понимает итог выполнения данного кода. Если для создателя кода нет разницы между переменными $a и $history_list, то для обычного человека это существенная подсказка и облегчение в восприятии информации.

Придерживайтесь стиля с начала до конца

Выберите для себя стиль кода и придерживайтесь его на всем пути текущего проекта. В стиль программирования входит стиль именования переменных. Как минимум, очень распространены следующие стили: my_history_list, MyHistoryList, myHistoryList, myhistorylist. Выберите один из данных стилей и придерживайтесь его до конца проекта. Наиболее распространен формат: myHistoryList, если он вам нравится, можете программировать, придерживаясь его.

Комментируйте код

Комментарии очень важны, особенно в тех местах, где код имеет особо сложную логику. Комментируя, вы можете разъяснить сложные функции, все входные данные и результат выполнения кода. Таким образом вы поможете не только стороннему разработчику, но и самому себе, если спустя через год или два, вам придется делать изменения в собственном коде. Сегодня вы все помните и знаете как работает, но через год вы не будете помнить все детально и вам придется потратить в разы больше времени, чтобы понять суть и методы выполнения собственного кода.

Лучшая документация - это комментарии в коде.

Разбивайте код на файлы

Имеет смысл сделать 10 файлов по 1000 строк, вместо одного файла, состоящего из 10,000 строк. Маленькие файлы более читабельны и быстро воспринимаются мозгом. Так, вы быстрее найдете код, отвечающий за нужный участок программы в разделенных по смыслу файлах (модулях), нежели в одном очень-очень большом файле.

Также не забывайте придерживаться смысловых названий для самих файлов (модулей) вашего кода. Потратив 10 лишних минут, на все это дело, вы сэкономите в разы больше в будущем. А сторонний программист поймет ваш код и оценит вашу аккуратность.

Поймите, почему это работает именно так, а не иначе

"О работает, но не должно. Да ну ладно.. главное работает!" - такой вариант никак не соответствует квалифицированному программисту. Вы должны на все 100% понимать ваш код, понимать как он работает и как он не должен работать ни при каких обстоятельствах. Вы должны быть абсолютно уверены, что ваш код работает сегодня и будет работать завтра, вне зависимости от входных данных.

Расставляйте все по полочкам

Не исключено, что в процессе составления вашего кода, вы имеете дело и с графическими составляющими, и с текстовыми. Код должен содержать исключительно инструкции и переменные. Все остальное должно лежать на своих полочках. Тем самым, графику держите в отдельных файлах и папках, тексты и словесные составляющие - в отдельных. Все составляющие подключайте отдельно и используйте через переменные и константы. Во-первых, это как и другие пункты, сделает код читабельным и чистым. Во-вторых, спустя время вам будет в разы легче изменить интерфейс или добавить мультиязычность.

Оптимизируйте использование ресурсов

Не всегда получается тратить много времени на оптимизацию кода и, чаще всего, люди придерживаются понятия: "Когда возникнет проблема - тогда и решим". Это может быть частично правильным решением, но никак не будет правильным для саморазвития. Сегодня вы можете потратить чуть больше времени, чтобы сделать ваш код лучше. Таким образом вы инвестируете в себя и завтра данный шаг уже будет делаться на автомате. Вы не будете повторно тратить больше времени, так как вы будете на новом уровне знаний.

Ваша программа использует 14мб оперативной памяти? Попробуйте снизить до 10мб. Получилось? А теперь попробуйте до 5мб. Хоть что-то у вас точно получится! И, в зависимости от вашей настойчивости и выделенного времени на проект, результат будет более существенным.

Очистка

На продакшене всегда очищайте все ненужное. Зачем вам 80% закомментированного кода? Пригодится завтра? Вряд ли! Делайте резервные копии и смело удаляйте все лишнее.

Никаких напрасных выполнений кусков кода в ненужных местах! У вас сайт и на нем есть модуль новостей? Зачем выгружать новости из базы в переменную, если вы его не используете на странице обратной связи? Используйте каждый кусок кода только там, где он необходим!

Улучшайте свой код постоянно

Не бойтесь признать, что вчера вы были глупее в разы, чем сегодня. Это совершенно нормально! Примите данный факт и если даже код, написанный вами два года назад, работает сегодня как надо, это не значит, что его нельзя улучшить. Вы стали круче и умнее? Улучшите код, дайте ему новую жизнь с более продвинутой начинкой.