Тексти модулів

Див. також

1. Тексти модулів повинні бути написані російською мовою. У текстах модулів не допускається використовувати літеру "ё".

3. Програмні модулі не повинні мати закоментованих фрагментів коду, а також фрагментів, які будь-яким чином пов'язані з процесом розробки (налагоджувальний код, службові позначки) і з конкретними розробниками цього коду. Наприклад, неприпустимо залишати подібні фрагменти в коді після завершення налагодження або рефакторингу:

Процедура ПередУдалением(Отказ)
	// Якщо Істина Тоді
	// Повідомлення("Для налагодження");
	// КінецьЯкщо;
КінецьПроцедури

також неправильно:

Процедура ПередУдалением(Отказ)
	Якщо Істина Тоді
		// Іванов: доробити 
	КінецьЯкщо;
КінецьПроцедури

Правильно: після завершення налагодження або рефакторингу видалити обробник ПередУдалением з коду.

4. Тексти модулів оформлюються за принципом "один оператор в одному рядку". Наявність кількох операторів допускається лише для "однотипних" операторів присвоєння, наприклад:

НачальныйИндекс = 0; Индекс = 0; Результат = 0;

5. Текст модуля повинен бути оформлений синтаксичним відступом. Для синтаксичного відступу використовується табуляція (а не пробіли, щоб при зміні кількості знаків у табуляції вирівнювання тексту зберігалося).

Розмір табуляції — стандартний (4 символи).

5.1. З крайньої лівої позиції повинні починатися лише:

• оператори Процедура, КонецПроцедуры, Функція, КонецФункции;
• оператори попереднього оголошення процедур і функцій;
• заголовки (описи) процедур і функцій;
• оголошення змінних модуля;
• оператори "розділу основної програми" (з урахуванням синтаксичного відступу);
• директиви компілятора &НаКлиенте, &НаСервере

5.2. Процедури НачатьТранзакцию і ЗафиксироватьТранзакцию не є операторними дужками, тому текст усередині цих процедур не зміщується.

6. За довжини рядка понад 120 символів слід використовувати перенесення. Робити рядки довшими за 120 символів не рекомендується, за винятком тих випадків, коли перенесення неможливе (наприклад, у коді визначено довгу рядкову константу, яка виводиться без перенесень у вікно повідомлень за допомогою об'єкта СообщениеПользователю).

Див. також: Перенесення виразів.

7.1. Тексти модулів можуть містити коментарі. Коментарі повинні бути достатньо зрозумілими, щоб пояснювати роботу модуля або коментованого оператора. Тексти коментарів повинні складатися за правилами російської мови, у діловому стилі, бути емоційно стриманими та не містити слів, що не належать до функціональності програми.

7.2. Невеликі коментарі пишуться наприкінці рядка, який вони коментують, наприклад:

НайденныеОшибки.Колонки.Добавить("Номер"); // для сумісності

Великі коментарі або коментарі до фрагмента коду пишуться перед коментованим кодом в окремому рядку.

7.3. Великі коментарі повинні починатися з великої літери й закінчуватися крапкою. Текст вирівнюється за лівою межею коментованого фрагмента. Між символами коментаря "//" і текстом коментаря має бути пробіл.

// Ініціалізуємо змінні для виконання розрахунків,
// які виконуються далі за текстом модуля.
ТекущаяДата = ОбщегоНазначения.ПолучитьРабочуюДату(); 
ТекущийГод = Год(ТекущаяДата); 
ТекущийМесяц = Месяц(ТекущаяДата); 
ТекущаяНеделя = НеделяГода(ТекущаяДата); 
ТекущийДень = День(ТекущаяДата);

Див. також

• Правила створення загальних модулів
• Структура модуля