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