5.1. Рекомендуемый стиль кода

Форматирование кода

  • Для Java и Groovy кода рекомендуется придерживаться стандартного стиля, описанного в документе Code Conventions for the Java Programming Language. При программировании в IntelliJ IDEA для этого достаточно использовать стиль по умолчанию, а для переформатирования применять сочетание клавиш Ctrl-Alt-L.

    Максимальная длина строки − 120 символов. Длина отступа - 4 символа, использование пробелов вместо символов табуляции включено.

  • XML код: длина отступа - 4 символа, использование пробелов вместо символов табуляции включено.

Соглашения по именованию

Идентификатор Правило именования Пример
Java и Groovy классы
Класс контроллера экрана

UpperCamelCase

Контроллер экрана списка сущностей − {КлассСущности}Browse

Контроллер экрана редактирования − {КлассСущности}Edit

CustomerBrowse

OrderEdit
XML дескрипторы экранов
Идентификатор компонента, имена параметров в запросах

lowerCamelCase, только буквы и цифры

attributesTable

:component$relevantTo

:ds$attributesDs
Идентификатор источника данных

lowerCamelCase, только буквы и цифры, оканчивается на Ds

 attributesDs
SQL скрипты
Зарезервированные слова lowercase create table
Таблицы UPPER_CASE. Название предваряется именем проекта для формирования пространства имен. В именах таблиц рекомендуется использовать единственное число.

SALES_CUSTOMER
Колонки UPPER_CASE

CUSTOMER

TOTAL_AMOUNT
Колонки внешних ключей UPPER_CASE. Состоит из имени таблицы, на которую ссылается колонка (без префикса проекта), и суффикса _ID. CUSTOMER_ID
Индексы UPPER_CASE. Состоит из префикса IDX_, имени таблицы, для которой создается индекс (с префиксом проекта), и имен полей, включенных в индекс. IDX_SALES_CUSTOMER_NAME
Пред.  Наверх  След.
  Начало