Мельница данных   (23.09.2017)
Соглашения о наименованиях

В качестве вводимых (объявляемых) идентификаторов необходимо использовать так называемую нотацию InfixCaps. Если при создании имени используется несколько слов, то необходимо использовать заглавную букву для каждого слова в имени. Для разделения слов нельзя использовать символ подчеркивания. Все сущности именуются на английском языке, при этом использование сокращений является оправданным только в случае, если длина образуемого имени не согласуется с внешними по отношению к соображениям бизнес-логики ограничениям.

  • Имя класса должно начинаться с латинской буквы 'T'.
           
    Имя Наименование
    TObjectList
    Список объектов
    TLearnPlan
    Учебный план
  • Имя поля должно начинаться с латинской буквы 'F'.
           
    Имя Наименование
    FLearnPeriod
    Период обучения
    FExamMark
    Оценка за экзамен
  • Имя свойства не имеет префикса.
           
    Имя Наименование
    ExamKind
    Вид рубежного испытания
    ContactPhone
    Контактный телефон
    Если членом класса для чтения свойства является поля, то имя свойства должно повторять имя поля без префикса 'F'. Если членом класса для чтения свойства является метод, то имя поля должно повторять имя метода без слова 'Get'.
  • Имя параметра не имеет префикса.
           
    Имя Наименование
    OrderNumber
    Номер приказа
    ExamDate
    Дата проведения экзамена
    Параметры, используемые для инициализации значений полей, должны иметь имя, повторяющее имя поля без префикса 'F'. При компиляции тела метода, написанного на языке PascalScript имена параметров и имена свойств будут распознаваться в соответствии с порядком разбора идентификаторов, как это описано здесь и здесь.
  • Имена методов должны представлять собой императивный глагол на английском языке, выражающий смысл того, что метод делает. Имена методов не имеют префикса. Имена методов, используемых для получения значений свойств должны (как члены класса для чтения), должны начинаться со слова Get. Имена методов, используемых для установки значений свойств должны (как члены класса для записи), должны начинаться со слова Set.
           
    Имя Наименование
    CountMarkSumm
    Вычислить сумму баллов
    GetAge
    Получить значение возраста
    SetMark
    Установить значение оценки
  • Имена локальных переменных должны начинаться с латинской буквы 'L'.
            LMarkSumm (сумма баллов), LObjectCount (количество объектов).
  • Имена доменов должны начинаться с латинской буквы 'T'. В именах доменов допустимы пробелы. Рекомендуется к имени домена добавлять слово 'domain' (через пробел), а для обязательных доменов 'required domain' (через пробел) тогда, когда необходимо исключить возможность использования этих доменов в текстах на PascalScript. Первым словом в имени домена-ссылки должно быть имя класса домена. Исключением являются имена доменов, соответствующих простым типам данных без дополнительных ограничений. Имена таких доменов могут повторять имена типов языка PascalScript (Integer, Boolean, Float).
           
    Имя Класс домена Наименование
    TPrice domain
    Вещественный
    домен Цена
    TWeight required domain
    Целочисленный
    домен Вес (обязательный)
    Boolean
    Логический
    Логический
    TClassMember required domain
    Ссылка
    домен Член класса
  • Имена элементов перечислений должны иметь префикс из двух или трех символов, идентифицирующий соответствующий домен-перечисление. Префикс записывается строчными буквами. Например,
           
    Имя Наименование
    для домена TExamKind (вид испытания)
    ekTest
    зачет
    ekExam
    экзамен
    ekDifTest
    дифференцированный зачет
    для домена TAggregateKind (вид агрегата)
    agCount
    количество
    agSumm
    сумма
    agAverage
    среднее значение
    Настоятельно рекомендуется давать уникальные имена элементов перечислений в пределах всей системы.