Здравствуйте, милые читатели нашего СМИ. Это снова Данин, и сегодня я хочу поговорить о чистом коде.
Что такое чистый код?
На самом деле нет четкого определения того, что такое чистый код, но вот несколько цитат, которые определяют, что такое чистый код:
«Мне нравится, чтобы мой код был элегантным и эффективным. Логика должна быть простой, чтобы было трудно скрывать ошибки, зависимости должны быть минимальными для облегчения обслуживания, обработка ошибок должна выполняться в соответствии с четко сформулированной стратегией, а производительность должна быть близкой к оптимальной, чтобы не соблазнять людей запутывать код беспринципными оптимизациями. Чистый код хорошо справляется с одной задачей». — Бьерн Страуструп, изобретатель C++ и автор книги «Язык программирования C++».
«Чистый код прост и прямолинеен. Чистый код читается как хорошо написанная проза. Чистый код никогда не скрывает замысел дизайнера, а скорее полон четких абстракций и прямых линий управления», — Грэди Буч, автор книги «Объектно-ориентированный анализ и проектирование с помощью приложений».
«Вы понимаете, что работаете над чистым кодом, когда каждая прочитанная вами подпрограмма оказывается почти такой, как вы ожидали. Вы можете назвать это красивым кодом, когда код также создает впечатление, что язык был создан для решения проблемы». — Уорд Каннингем, изобретатель Wiki, изобретатель Fit, соавтор экстремального программирования.
Суммируя приведенные выше цитаты, чистый код — это попытка создать простой, понятный, но в то же время эффективный код.
Как мы очищаем код?
Чтобы ответить на этот вопрос, спросите себя: как вы убираете свою комнату?
На практике уборка комнаты и код уборки сильно отличаются. Но основы остаются прежними. Мы убираемся в своей комнате, чтобы все было организовано, чтобы не пахло, и чтобы тот, кто пользуется комнатой, чувствовал себя комфортно. Ну, мы чистим наш код, чтобы все было организовано, чтобы он не пах (код пахнет — это вещь), и чтобы тот, кто использует код, пользователь или разработчик, чувствовал себя комфортно.
Вот несколько вещей, которые вы можете сделать, чтобы реализовать чистый код:
1. Значимые имена
Вы хотите, чтобы ваши переменные объясняли, что они делают. Представьте себе такой сценарий: у вас есть программа, которая подсчитывает общую стоимость списка товаров. Итог хранится в переменной с простым названием total. Вот это хорошо, но допустим в вашей программе тоже есть счетчик общего количества совершенных покупок. Теперь имя переменной total неоднозначно. Переименовав переменную, скажем, в total_price, мы проясним значение переменной и уменьшим двусмысленность.
2. Комментарии по качеству
Комментарии не должны объяснять код; Код должен быть понятным. Для чего следует использовать комментарии, так это для объяснения намерений, прояснения проблемных моментов, последствий или предупреждений, а также комментариев TODO среди прочего.
3. Лаконичные функции
Создавайте простые функции с четкой целью. Вместо того, чтобы иметь много одного и того же кода, мы можем хранить его весь в функции. Не делайте функцию слишком длинной и убедитесь, что ее легко понять другим людям для повторного использования.
4. Элегантная обработка ошибок
Вы хотите заранее написать оператор try-catch на случай появления ошибок. Вы также хотите определить нормальный поток и размещать исключения только там, где они, скорее всего, появятся. Используйте непроверенные исключения, чтобы предотвратить ошибки во время выполнения.
5. Форматирование кода
Форматирование кода означает согласованные пробелы и табуляции, пробелы и очень мелкие детали, которые вы обычно не замечаете при обычном кодировании. Их можно найти с помощью линтеров, таких как pylint и flake8, и хотя в этом нет необходимости, это помогает повысить общее качество кода.
…и многое другое!
Я могу говорить о том, как почистить ваш код весь день, но, к сожалению, у меня нет на это всего дня. Весь смысл чистого кода в гибкой среде заключается в том, чтобы у каждого разработчика был стандарт для работы. Вы не можете просто отдать свой спагетти-код с ошибками другому разработчику в надежде, что он сможет его исправить. Кл
Это все на данный момент. Увидимся в следующий раз!
