Чтобы быть хорошим разработчиком программного обеспечения, нужно не только изучать правильные языки или знать, как использовать каждый фреймворк. Дело не только в том, чтобы знать каждый пакет или библиотеку, которые вы можете использовать. Чтобы быть хорошим программным обеспечением, нужно не писать причудливый код, а писать хороший код. Хороший код определяют люди, которые приходят после вас и читают то, что вы написали. Легко понять? Понятно ли это по смыслу? Легко ли поменять? Все это признаки чистого кода, а умение писать чистый код - самый важный навык, которым может обладать разработчик.
В мире разработки программного обеспечения часто бывает, что никто не хочет продолжать определенный проект не потому, что не видит в нем ценности или не думает, что обладает необходимыми навыками, а потому, что код беспорядочный и ужасный. читать. Есть несколько причин, по которым разработчик может писать беспорядочный код. Это может быть потому, что они находятся под давлением приближающегося дедлайна, или потому, что они самоучки и не знают, как правильно писать код. В любом случае это приводит к проекту, над которым никто не хочет работать, потому что им потребуется в десять раз больше времени, чтобы прочитать ваш код, чем вам, чтобы его написать.
Что делает код чистым
Чистый код имеет несколько общих характеристик. Знакомство с ними поможет нам в изучении искусства написания хорошего кода.
- Читаемость: чистый код должен быть легко читаемым. Если кто-то позже будет читать ваш код, ему должно казаться, что он читает прозу.
- Элегантность: как и в случае с первой характеристикой, ваш код должен быть приятным для чтения.
- Простота: ваш код должен быть легким для чтения и понимания. Он должен соответствовать принципу единой ответственности, то есть каждый метод / переменная в вашем коде должен служить одной цели. Подробнее об этом позже.
- Возможность изменения: в код должно быть легко вносить изменения позже, если кому-то понадобится обновить его для соответствия новым требованиям.
- Наконец, чистый код должен пройти все тесты.
Как написать более чистый код
Теперь мы подробно рассмотрим, как содержать код в чистоте. В названии я обещал шесть советов по написанию лучшего кода, и вот они:
Используйте значимые имена
Вы будете писать много имен в своем коде. У вас будут переменные, функции, классы, методы, пакеты и многое другое, и каждому из них потребуется определенное имя. Первый шаг к написанию чистого кода - сделать эти имена понятными и значимыми. Любое имя, которое вы используете, преследует три цели. Он должен четко сообщать, что он делает, почему он существует и как он используется. Для простых имен переменных вам может потребоваться добавить комментарий, чтобы подробнее объяснить назначение переменной. Помните, насколько очевидным это может быть для вас в данный момент, тот, кто читает ваш код в будущем, не будет знать, чего вы пытаетесь достичь, и им нужно будет легко понять это на основе вашего кода. сам. Таким образом, необходимы хорошие шаблоны именования и комментирования.
Принцип единой ответственности (SRP)
Я сказал вам, что мы снова будем об этом говорить. Когда вы пишете методы, классы и функции, может возникнуть соблазн добавить новые функции, когда вы узнаете, что они вам нужны. Сначала ваша функция выполняет только одно действие, но затем вы понимаете, что хотите добавить новую функцию, а затем еще одну, а затем еще одну ... Прежде чем вы это узнаете, у вас есть одна функция, которая выполняет семь разных задач одновременно. Каким бы сильным ни было это побуждение, вы должны ему противостоять. Так же, как важно иметь простые и понятные имена, важно иметь функции с простыми и понятными целями. Каждый метод, который вы пишете, должен делать одно и только одно. Это помогает сделать ваш код более читабельным и более легким для изменения, поскольку легче найти критически важный фрагмент кода, если он четко помечен и прост в своей функции.
Избегайте написания лишних комментариев
Я знаю, что только что говорил о полезности комментариев и о том, как они могут сделать ваш код более читабельным, но важно воздержаться от написания слишком большого количества из них. Они усложняют перемещение вещей в вашем коде, поскольку вам придется не забывать перемещать и все соответствующие комментарии, и они могут фактически запутать кого-то, кто пытается следовать вашему коду в первый раз. По мере того, как вы научитесь четко и явно называть свои переменные и методы, вам потребуется все меньше и меньше комментариев, пока не останутся только действительно необходимые.
Написать читаемый код
Я знаю, что все эти советы призваны сделать ваш код более читабельным, но этот, в частности, очень легко реализовать и получить огромную выгоду. Помните, что однажды этот код будет читать кто-то другой, и вы хотите, чтобы он тек, как проза. С этой целью не забывайте делать отступы и использовать разрывы строк. Вы же не хотите, чтобы кому-то приходилось прокручивать страницу в сторону, чтобы увидеть конец вашей строки кода. Тот факт, что среда кодирования, которую вы используете, не требует переноса слов, не означает, что вы не должны помнить об этом, когда пишете.
Помните о своих зависимостях
Если возможно, ваши зависимости всегда должны быть в одном направлении. Представьте, что у вас есть класс под названием car, и этот класс зависит от другого класса под названием wheel. Пока колесо не зависит от автомобиля, это однонаправленная зависимость. Автомобиль может использовать колесо, и это нормально, но колесу все равно, кто его использует - это может быть машина, самолет или даже лодка. Неважно. Проблема возникает, когда вы заставляете колесо зависеть от машины. Хотя эти классы должны быть независимыми друг от друга, они действительно могут существовать только вместе. Становится сложно обновлять системы с двунаправленными зависимостями, поэтому убедитесь, что ваша зависимость идет только в одном направлении.
Держите свой код организованным
Чистый код начинается сверху с ваших папок и каталога вашего проекта. Указывайте имена папок явно, как и имена переменных, и убедитесь, что каждый файл находится там, где вы ожидаете. Трудно создать идеальную организационную структуру с первого дня, но по мере того, как вы продолжаете работать над своим проектом, вам нужно начать осторожно относиться к своим папкам и организационной структуре вашего каталога. Наличие хорошо организованного и поддерживаемого каталога проекта - это первый шаг к созданию читаемого и чистого кода.
Заключение
Написание чистого кода - это постоянный процесс, который требует постоянного обучения. Ни один разработчик не поймет это правильно с первого раза. К сожалению, многие этого не делают. Важно, чтобы вы продолжали улучшать и писать более читаемый код в каждом последующем проекте, над которым вы работаете. Для получения дополнительной помощи я рекомендую ознакомиться с существующими руководствами по стилю для любых языков и фреймворков, которые вы используете, для получения более подробных и подробных советов. Как всегда, спасибо за чтение и вернусь на следующей неделе за другой статьей!
