Embarcadero только что опубликовал на сайте docwiki обновленную версию руководства по языковым стилям. Документ был обновлен, чтобы охватить современные возможности языка Delphi и некоторые изменения стиля кодирования.
За последние несколько месяцев я предпринял попытку опубликовать новое руководство по стилю Object Pascal для современного языка Delphi. Из предисловия:
«Этот документ представляет собой обновленную версию классического руководства по стилю Object Pascal, первоначально созданного Чарли Калвертом для Borland во время первоначального выпуска Delphi. Обновленную версию курировал менеджер по продуктам Delphi Марко Канту при участии внутренней группы исследований и разработок, MVP Delphi и всего сообщества Delphi ».
Текст не является руководством по языку, скорее он описывает использование пробелов и форматирования при написании кода — то, что компилятор обычно игнорирует. Здесь нет ничего обязательного, это просто рекомендация в пользу удобочитаемости. Соблюдение этих правил является требованием для нашей собственной внутренней команды и любого участника.
Вы можете найти руководство по стилю на http://docwiki.embarcadero.com/RADStudio/Sydney/en/Delphi’s_Object_Pascal_Style_Guide .
Это индекс документа:
- Вступление
- Общие правила: идентификаторы, ключевые слова, отступы
- Файлы исходного кода, блоки и их структура
- Использование белого пространства
- Комментарии
- Заявления
- Объявления типов
Я закончу этот блог кратким введением:
В то время как компиляторы Delphi обычно игнорируют любые пробелы и обеспечивают большую гибкость в том, как разработчик пишет код, для удобства чтения и поддержки исходного кода, Embarcadero определил набор руководящих принципов, используемых внутренними исследованиями и разработками и любым разработчиком, участвующим в проект. Мы рекомендуем сообществу Delphi в целом принять этот стиль кодирования и форматирования.
Введение в первоначальную версию этого документа прекрасно это выражает:
«Object Pascal — это красиво оформленный язык. Одно из его главных достоинств — удобочитаемость. Эти стандарты разработаны для повышения читабельности кода Object Pascal. Когда разработчики следуют простым соглашениям, изложенным в этом руководстве, они будут продвигать стандарты, которые принесут пользу всем разработчикам Delphi за счет использования унифицированного стиля, который легко читать. Усилия по обеспечению соблюдения этих стандартов повысят ценность исходного кода разработчика, особенно во время циклов обслуживания и отладки ».
В этом документе не упоминаются и не объясняются синтаксис и грамматика языка, поскольку он сосредоточен только на определении стиля написания кода в тех местах, где язык дает вам выбор, позволяя использовать множество различных вариантов с точки зрения пробелов и форматирования.
Ни одно из этих указаний не высечено на камне, и мы ожидаем, что они со временем будут развиваться вместе с языком.
Design. Code. Compile. Deploy.
Start Free Trial Upgrade Today
Free Delphi Community Edition Free C++Builder Community Edition
