autumn icon indicating copy to clipboard operation
autumn copied to clipboard

Документировать класс СоветДругогоМастера

Open Copilot opened this issue 10 months ago • 1 comments

Добавлена полная документация для класса СоветДругогоМастера, который ранее не был документирован. Класс является важным компонентом фреймворка ОСень для управления параметрами приложения.

Изменения

Добавлено описание класса:

  • Объяснение назначения класса как конфигуратора для управления параметрами приложения
  • Контекст интеграции с МенеджерПараметров и классом Поделка
  • Описание поддерживаемых источников конфигурации (переменные среды, файлы JSON/YAML/INI, прямые значения)

Улучшена документация методов:

  • Детальные описания каждого метода с объяснением назначения
  • Примеры использования для каждого метода
  • Уточнены типы параметров и возвращаемых значений
  • Добавлены пояснения о поведении системы

Добавлен раздел с примером использования:

// Создание и настройка советника для конфигурации приложения
Совет = Новый СоветДругогоМастера();

// Установка значений деталек напрямую
ЗначенияДеталек = Новый Соответствие();
ЗначенияДеталек.Вставить("app.name", "МоеПриложение");
ЗначенияДеталек.Вставить("app.version", "1.0.0");

Совет.ЗначенияДеталек(ЗначенияДеталек)
     .ПрефиксПеременныхСреды("MYAPP_")
     .ИмяФайлаСоЗначениямиДеталек("application")
     .ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек("config");

// Использование в создании поделки
Поделка = Новый Поделка(Совет);

Объяснение поведения системы:

  • Описание приоритетов загрузки параметров
  • Пояснение форматов поддерживаемых конфигурационных файлов
  • Примеры использования переменных среды с префиксами

Fixes #76.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot avatar Jun 13 '25 01:06 Copilot

Синхронно меняй файл md и bsl с исходником.

Но вообще изначально я имел ввиду документацию в docs/product

Выполнено в коммитах 1b95da9 и 37f7925 - синхронизировал .md и .bsl файлы, также добавил документацию в docs/product/framework-elements/060-app-settings-injection.md.

Copilot avatar Jun 13 '25 01:06 Copilot