Введение
Данный документ содержит рекомендации к оформлению кода, призванные упростить поддержку проектов, написанных на языке программирования Delphi. Рекомендации максимально приближены к стандартам Borland и Embarcadero, разработчиков компиляторов языка. Материал содержит и авторские рекомендации, которые основаны на анализе продуктов, принадлежащих данным компаниям.
Целью документа является более-менее четкое описание правил оформления исходного кода при создании программ. Поскольку Delphi часто используется как средство обучения базовым навыкам программирования, важно выработать у обучающегося хороший стиль написания кода. По этой причине материал, изложенный в данном источнике, в первую очередь предназначен для учащихся высших, средних специальных учебных заведений и учреждений среднего общего образования. Автор, сам являясь студентом, создал его и для личного пользования.
Содержание данного материала основывается на статье "Object Pascal Style Guide" Чарльза Калверта на ресурсе Embarcadero Developer Network и в значительной части представляет ее перевод с некоторыми изменениями. Так как статья была опубликована давно, такие изменения необходимы для соответствия рекомендаций особенностям современной разработки. Однако материал документа несколько шире, чем материал статьи: была принята попытка исправить обозначенные пользователями недочеты Чарльза, а также дополнить подготовленную им информацию.
Язык программирования Delphi постоянно развивается. С ним растет и объем материала, который необходимо охватить в рамках руководства по оформлению кода. Важной задачей является сохранение актуальности и гарантия корректности изложенных рекомендаций, поэтому приветствуется любая помощь с редактирование данного документа.
Режимы доступа к материалу
- GitBook. Наиболее удобный вариант для чтения.
- GitHub. Репозиторий, содержащий исходные файлы материала.
Список использованных ресурсов
Для обратной связи
- [email protected], Арсений Рынкевич.