Руководство по оформлению кода

Руководство по оформлению кода

Однажды Гарольд Абельсон, человек уважаемый в мире компьютерных наук, сказал:

“ПРОГРАММЫ ДОЛЖНЫ ПИСАТЬСЯ ДЛЯ ТОГО,
ЧТОБЫ ИХ ЧИТАЛИ ЛЮДИ, А ВЫПОЛНИМОСТЬ
ЭТИХ ПРОГРАММ МАШИНАМИ — ПОБОЧНЫЙ
ЭФФЕКТ”.

Конечно, это шутка, но … Предположим, Ваша программа работает, но код оформлен плохо. Коллеги в таком коде разбираться не будут, через месяц и Вы в нем ничего не поймете. Программа всегда требует доработки, у Вас же она получается одноразовой. Смысл?

Короче, Вы уже поняли: оформление программного кода должно быть стандартизировано. Этим мы сейчас и займемся.

Основные принципы

1. Если операторы выполняются один за другим, они пишутся один под другим.

2. Если один оператор управляется другим, то он пишется на следующей строке с отступом внутрь управляющего оператора.

Пробелы, отступы и шрифт

Шрифт для написания кода надо выбирать моноширинный (все символы одной ширины). Для этого в Lazarus: Главное меню → Сервис → Параметры → Редактор → Отображение → Шрифт редактора по умолчанию → Courier New / Courier → ОК.
Межстрочный интервал лучше делать равным единице.

Договоримся использовать отступы в 4 пробела. Для этого надо научить свой редактор вставлять 4 пробела при нажатии клавиши табуляции. Для этого в Lazarus:
Главное меню → Сервис → Параметры → Редактор → Общие → Табуляция и отступ → Преобразование Tab в пробелы → 4 → ОК.

Иногда требуется увеличить или уменьшить отступ у целого блока программы. Для этого в Lazarus: Главное меню → Сервис → Параметры → Редактор → Общие → Табуляция и отступ → Отступ блока Ctrl+I / Ctrl+U → Отступ блока в пробелах → 4 → ОК.

Ставьте пробелы после запятых, двоеточий и точек с запятой (формальные параметры в подпрограммах) так, как это делается в книгопечатании.

Ставьте пробелы вокруг бинарных операций.

Между блоками описаний (константы, типы, подпрограммы, переменные) и перед выполнимой частью программы вставляйте пустую строку (“вертикальный пробел”).

Когда строка становится длиннее 80 символов, разделите её на две, сделав перевод на новую строку после оператора, и продолжайте писать.

Ниже приведены примеры на тему «что такое хорошо и что такое плохо».

Пример 1. Отступы и пробелы