Регионы и примеры

Карта регионов модуля

#Region ModuleMap
// Модуль (flags: Server + External + Client)
// Requires: ...
//
// Regions:
//   Module_Public     – Экспортные функции
//   Module_Internal   – Внутренние функции
//   Module_Aliases    – RU/EN алиасы
//   Module_Utils      – Вспомогательные
//   Module_SelfTest   – Юнит-тесты
#EndRegion

• Карта — вверху файла, обновляется при изменениях.
• Имена регионов: префикс модуля + роль (A1sX_ToXML, A1sX_FromXML …).

Шаблон функции с XML-доком и ib

// <doc>
 //   <summary>Чтение текстового файла</summary>   ✦
 //   <param i="1" name="Path" type="String">Путь к файлу</param>   ➤
 //   <returns>String — содержимое или Неопределено</returns>   ⬅
 // </doc>

Функция ReadText(Path, Encoding="UTF-8") Экспорт   //⚙
    ib = "Чтение файла";   //✍
    // ...
    Возврат "OK";   //↩
КонецФункции

• XML-док: без второго // перед маркерами.
• Код: все маркеры внутри хвостового комментария.

Где держать примеры

• Короткие — в <example> внутри XML-дока.
• Длинные — отдельный регион #Region examples_FunctionName.

#Region examples_ReadText
// Пример 1:
//   T = A1sFS.ReadText("C:\temp\info.txt");
//   // ожидаем: непустая строка
//
// Пример 2:
//   T = A1sFS.ReadText("C:\temp\missing.txt");
//   // ожидаем: Неопределено
#EndRegion