Какие приемы используются для улучшения читаемости кода?

Некоторые приёмы, которые используются для улучшения читаемости кода:

• Осмысленные имена переменных. spravochnick.ru Они должны верно описывать то, что представляют собой. spravochnick.ru Важно, чтобы переменная всегда использовалась только с той целью, которую предполагает её имя. spravochnick.ru
• Разбивка кода на самостоятельные функции. spravochnick.ru Функции должны иметь небольшой размер, минимум побочных эффектов и быть реализованы по принципу «одна функция — одно действие». spravochnick.ru
• Использование именованных констант. spravochnick.ru Вместо магических чисел в коде нужно применять константы с осмысленными названиями. spravochnick.ru
• Выделение важных фрагментов кода. spravochnick.ru Для привлечения внимания читателя к отдельным участкам кода можно, например, расположить объявления в классе: сначала — информацию об открытых объектах, в конце — закрытые детали реализации. spravochnick.ru
• Объединение взаимосвязанных данных. spravochnick.ru Вся связанная между собой информация должна находиться в одном месте. spravochnick.ru
• Заголовки файлов. spravochnick.ru В начале файла стоит помещать блок комментариев с описанием содержимого файла и проекта, к которому он относится. spravochnick.ru
• Корректная обработка ошибок. spravochnick.ru Обработка ошибок должна размещаться в наиболее подходящем контексте. spravochnick.ru
• Использование пробелов для группировки взаимосвязанных элементов. proglib.io Пробелы улучшают читаемость кода, если они стоят вокруг операторов присваивания, после запятых при перечислении переменных. proglib.io
• Отступы. proglib.io Размер отступов должен соответствовать позиции кода в иерархии. proglib.io Это позволяет быстро пропускать области видимости, не относящиеся к текущей ситуации. proglib.io