7 рекомендаций по написанию чистого кода
«Поэтому, если вы хотите работать быстро, если вы хотите быстро закончить работу, если вы хотите, чтобы ваш код было легко писать, сделайте его легко читаемым», — Роберт С. Мартинс.
Чистые коды — это коды, которые легко читать и понимать. Написание чистого кода имеет важное значение в программировании, потому что это облегчает другим разработчикам участие в ваших проектах. Более того, написание чистого кода упрощает обслуживание как для автора, так и для других программистов. Поэтому для нас крайне важно сделать наши коды чистыми. Наши коды должны быть понятны как людям, так и машинам. В этом блоге я поделюсь с вами семью рекомендациями по написанию чистого кода. Давайте углубимся:
1. Описательные имена переменных
Чистота базы кода начинается с того, как названы переменные. Чтобы код был чистым, имена переменных должны описывать значение, которое они содержат. Длинное описательное имя переменной лучше, чем короткое бессмысленное имя переменной.
Вместо
p = 20.0
Использовать
price = 20.0
То же самое применимо и при именовании функций. Имена функций должны описывать, что делает функция.
2. Согласованное соглашение об именах
Помимо использования описательных имен для переменных, вы также должны следовать согласованному соглашению об именах. Двумя основными способами именования переменных являются верблюжий регистр (как в areaOfCircle) и змеиный регистр (как в area_of_circle). Рекомендуется выбрать одно соглашение об именах и поддерживать его на протяжении всего проекта. Также константы должны быть названы заглавными буквами, а имена классов всегда должны начинаться с заглавной буквы.
3. Углубления
Еще одна вещь, которая делает код чистым, — это отступы. Отступ — это пробел в начале строки кода. Это часть синтаксиса некоторых языков программирования, таких как Python и Occam. Однако не имеет значения, является ли отступ частью синтаксиса вашего языка программирования или нет, вы всегда должны применять его в другом, чтобы улучшить читаемость кода. Правило состоит в том, что каждый код в одном блоке должен иметь одинаковый уровень отступа. Кроме того, блок кода, вложенный в другой блок кода, должен иметь больший отступ, чем родительский блок кода. Когда вы следуете правилам, программистам легко идентифицировать блоки кода. Это также повышает чистоту вашего кода.
4. Разрывы строк
Когда коды слишком длинные, это приводит к горизонтальной прокрутке, что негативно сказывается на читабельности. Поэтому важно применять перенос строки там, где это необходимо, чтобы предотвратить горизонтальную прокрутку. Даже при отсутствии горизонтальной прокрутки рекомендуется, чтобы длина строки кода не превышала 80–100 символов.
5. Пробелы
Пробелы создают дыхание кода — они оживляют код. Это пространство, которое не влияет на то, как машина интерпретирует наши коды. Пробелы включают использование отступов, разрыва строки и пробела. Правильное использование пробелов делает код читабельным.
6. Комментарии
Комментарии — это операторы, добавляемые к компьютерному коду исключительно для человеческого восприятия. Они игнорируются машиной во время выполнения. Комментарии следует использовать только тогда, когда необходимо добавить дополнительную информацию к кодам. Цель комментариев — улучшить читаемость кода. Они не предназначены для деактивации кодов во время выполнения.
7. Ридми
Файл readme также используется для добавления дополнительной информации к программному приложению. Они объясняют, что делает приложение, как оно это делает и как его можно использовать. Они также содержат любую другую информацию, которую программист может счесть необходимой. Файлы Readme обычно записываются с информацией об уценке или текстовом файле. Они должны быть добавлены, чтобы помочь пользователям понять наше приложение.
Вывод: написание чистого кода делает вас выдающимся в разработке программного обеспечения. Его следует принимать с легкостью.
Я Чеквубе Утоми, разработчик программного обеспечения в области науки о данных, веб-сайтов и технического письма.
Не забывайте хлопать, делиться и подписываться на меня на Medium.
Вы также можете подписаться на меня в LinkedIn.
