Некоторые основные принципы оформления кода в текстовых файлах:
- Использование горизонтальных и вертикальных отступов. 3 С их помощью выделяются отдельные циклы, функции и другие элементы. 3 Горизонтальный отступ проставляется с помощью двух или четырёх пробелов. 3
- Не превышение оптимальной длины строки. 3 Максимальная длина строки — 80 символов. 3 Если их больше, то читать и понимать код становится тяжелее. 3 Когда количество символов превышает оптимальное, код лучше разбить на несколько строк. 3
- Правильное использование фигурных скобок. 3 Есть два общепринятых метода: ставить скобки сразу после кода или параллельно друг с другом. 3
- Осмысленные названия переменных и функций. 4 Они должны отвечать реальным целям. 4
- Комментарии к коду. 35 Правильно написанный комментарий делает код более понятным и объясняет, почему задача решена так, а не иначе. 3
- Отделение логических блоков кода одной или двумя пустыми строками. 4 Например, после описания переменных нужно вставить пустую строку, а после инициализации переменных — ещё одну пустую строку. 4
Стандарт оформления кода зависит от используемого языка программирования. 1