Соглашение об именованиях
Идентификаторы.
Идентификаторы (имена) используются для именования переменных, констант и функций.
Длина идентификатора ограничена 31 символом. Все символы идентификатора являются значимыми. Идентификатор прерывается любым символом, не являющимся допустимым для идентификатора, либо концом строки. Идентификатор должен начинаться с буквы или знаков "_" (подчеркивание) и "?" (вопросительный знак). Второй и последующие символы идентификатора могут быть как перечисленными символами, так и цифрами. В идентификаторах допускается использование как русских, так и латинских букв. В идентификаторах допускаются буквы как верхнего, так и нижнего регистра, причем регистр букв имеет значение.
Идентификаторами не могут быть ключевые слова языка. Некоторые из ключевых слов играют роль идентификаторов для стандартных типов данных, т.е. их использование зарезервировано.
Примеры:
// правильные идентификаторы:
к
сч01
Итого
Сумма_Прописью
// неправильные идентификаторы:
7Дней // начинается с цифры
@льфа // недопустимый первый символ @
Петров&K // недопустимый символ &
ЦИКЛ // является ключевым словом
ТИП_ДАТА // является ключевым словом – идентификатором стандартного
// типа
ПостроитьОборотнуюВедомостьВРазрезеКонтрагентов // слишком длинный,
// более 31 символа
Соглашение об именовании.
Соглашение об именовании необходимо для минимизации конфликтов имен между платформой и прикладным кодом, а также между различными частями прикладного кода.
Здесь рассматриваются правила именования для платформы, которые следует учитывать всем прикладным разработчикам. Выработка стандарта кодирования для различных частей прикладного кода выполняется разработчиками самостоятельно.
1. Ключевые слова
Все ключевые слова языка образованы только из заглавных букв. Слова разделены символом подчеркивания. Имена типов начинаются с приставки ТИП_.
2. Встроенные функции и методы
Имена встроенных функций и методов объектных типов образуются только из заглавных букв. Слова разделены символом подчеркивания. Единственным исключением из этого правила являются методы ТИП_ГРАФИК. Все новые функции, добавляемые в платформу, будут следовать этому правилу.
3. Поля объектных типов
Поля объектных типов образованы только из прописных букв. Слова разделены символом подчеркивания. Прямая доступность полей по имени имеет место только в определении собственных методов объектного типа. При обращении "через точку", с указанием имени переменной объекта, имя поля не конфликтует с именами переменных и функций.
4. Системный резерв
Идентификаторы начинающиеся с "_" (символа подчеркивания) зарезервированы для объявлений, обрабатываемых платформой особым образом. Следует избегать таких имен в обычном коде.
Рекомендации по именованию.
Определяя идентификаторы, не рекомендуется злоупотреблять символами "_" и "?", иначе могут появиться переменные вроде "__?__", которые превратят чтение исходного текста в утомительное занятие. С другой стороны, частое использование коротких идентификаторов (и, к, ст, вс и т.п.) может привести к неочевидному использованию переменных и функций, а также не отражает в полной мере их смысл. Рекомендуется определять идентификаторы, отражающие природу идентифицируемой сущности. Например, идентификатор "дата1" хорош для именования переменной, обозначающей дату начала некого периода времени, а идентификатор "сумма_всего" – для именования итоговой суммы. Рекомендуется избегать введения идентификаторов, отличающихся только регистром букв.
Обычно, в разных языках программирования и библиотеках используется одно из трех следующих правил именования:
// правило 1: каждое слово начинается с заглавной буквы Год СформироватьГодовойОтчет // правило 2: каждое слово, кроме первого, начинается с заглавной // буквы год сформироватьГодовойОтчет // правило 3: используются только прописные буквы, слова разделяются // символами подчеркивания год сформировать_годовой_отчет
Во внутреннем языке Инфо-Бухгалтер 8 является допустимым следование любому из этих правил.