Как сделать чистый код понятнее: основные рекомендации

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

Меньше кода – всегда лучше.

Когда дело доходит до написания программного обеспечения, часто при запуске и написании самых первых строк нашего класса может быть немного больше кода, чем необходимо. Например, общедоступный метод в сервисе может содержать несколько переменных, которые не нужны, блок логики или операторы «если», которые должны быть выделены в отдельный метод. Например, результат метода можно использовать непосредственно в коде, создание переменной и присвоение результата этой переменной не является обязательным. Чистый код всегда будет понятен для всех программистов, не зависимо от одного человека, который его написал.

Уменьшите объем кода в одном месте. Удалите неиспользуемые переменные. Также удалите комментарии – код должен быть понятным.

Метод извлечения.

Как долго ваш метод? Если в нем более 20 строк, много операторов if, циклов и т. Д., Вам следует подумать об этом. Извлеките его в другой метод с собственным именем, которое дает представление о том, что он делает, четко одним взглядом без анализа логики. Зачем использовать метод извлечения? Потому что это помогает держать легко читаемую структуру метода. Всегда лучше читать один метод, содержащий 20 строк, вызывающих 10 различных методов, чем метод, содержащий 400 строк безымянной логики и искаженного комментария.

Чистый код – хороший нейминг

Стоит потратить некоторое время на то, чтобы найти собственное имя для создаваемого нами класса, метода, переменной. Это сэкономит нашим коллегам много времени. Не используйте аббревиатуры, имена должны быть простыми и понятными. Например, «usersAction» – это нечеткое название метода – чтобы понять, что оно означает, вам нужно заглянуть внутрь тела метода. Напротив, метод с самоочевидным именем может быть «saveUserInDataBaseAndSendAnEmail». Это имя точно указывает, что делает метод. Внутри вы можете ожидать отдельные методы с именами: «saveUser», «sendAnEmailAboutSavedUser».

  • Переменная, имя должно указывать, какие данные в ней хранятся или какая служба скрывается за ними.
  • Метод, считывающий имя метода. Вы должны точно знать, что он делает, не вдаваясь в логику.
  • Класс должен быть назван в соответствии с доменом (часть логики системы, за которую он отвечает, например, доменом могут быть платежи, счета и т. Д.). Если класс начинает расти более чем на 200 строк, подумайте о его разделении.

Выделим еще раз. Чистый код означает преимущества: приятная работа, меньше стресса, модульные тесты, простая отладка и лучшее качество.

Мы знаем, что если вы имеете дело с запутанным кодом, работа с такой средой потребует больше времени, нервов и энергии, чем следовало бы. Это не потому, что вы плохой программист, а просто потому, что анализ этого кода занимает много времени и (поскольку мы всего лишь люди) расстраивает и утомляет. Никому не нравится работать с плохо спроектированным кодом.

Добавлено: 23.12.2020
оставить комментарий

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *

Наверх
Телефон
Чат
Заявка
Меню