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

docs/api/050-Классы/20-СоветДругогоМастера.md

@@ -4,66 +4,124 @@ title: СоветДругогоМастера
 
 # СоветДругогоМастера
 
+Класс-конфигуратор для управления параметрами приложения в фреймворке ОСень. Инкапсулирует настройки для работы с `МенеджерПараметров`, включая значения деталек (параметров), префиксы переменных среды, имена конфигурационных файлов и каталоги поиска.
+
+Используется в классе `Поделка` для инициализации системы управления параметрами приложения, позволяя настроить различные источники конфигурации: переменные среды, файлы JSON/YAML/INI, и прямые значения.
+
 ## ПриСозданииОбъекта
 
 ```bsl
-// Советы по созданию поделки, упакованные в объект.
+// Создает объект с настройками по умолчанию для управления параметрами приложения.
+// Инициализирует пустое соответствие значений деталек, устанавливает имя файла 
+// конфигурации "autumn-properties" и каталог поиска "src".
 //
 Процедура ПриСозданииОбъекта()
 ```
 
 ## ЗначенияДеталек
 
 ```bsl
-// Установить/получить значения деталек.
+// Установить/получить значения деталек (параметров конфигурации).
+// Деталки передаются в МенеджерПараметров для настройки системы параметров.
 //
 // Параметры:
-//   НовоеЗначение - Соответствие - устанавливаемые значения деталек.
+//   НовоеЗначение - Соответствие - устанавливаемые значения деталек в формате "ключ-значение".
 //
 //  Возвращаемое значение:
 //   Соответствие, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
 //
+// Пример:
+//   Совет = Новый СоветДругогоМастера();
+//   ЗначенияДеталек = Новый Соответствие();
+//   ЗначенияДеталек.Вставить("app.name", "МоеПриложение");
+//   ЗначенияДеталек.Вставить("app.version", "1.0.0");
+//   Совет.ЗначенияДеталек(ЗначенияДеталек);
+//
 Функция ЗначенияДеталек(НовоеЗначение = Неопределено) Экспорт
 ```
 
 ## ПрефиксПеременныхСреды
 
 ```bsl
 // Установить/получить префикс переменных среды, хранящих значения деталек.
+// Используется для поиска переменных среды, начинающихся с указанного префикса.
 //
 // Параметры:
 //   НовоеЗначение - Строка - устанавливаемый префикс переменных среды.
 //
 //  Возвращаемое значение:
 //   Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
 //
+// Пример:
+//   Совет = Новый СоветДругогоМастера();
+//   Совет.ПрефиксПеременныхСреды("MYAPP_");
+//   // Теперь будут читаться переменные среды вида MYAPP_PARAM_NAME
+//
 Функция ПрефиксПеременныхСреды(НовоеЗначение = Неопределено) Экспорт
 ```
 
 ## ИмяФайлаСоЗначениямиДеталек
 
 ```bsl
 // Установить/получить имя файла (без расширения), в котором хранятся значения деталек.
+// Система будет искать файлы с этим именем и расширениями .json, .yaml, .yml, .ini.
 //
 // Параметры:
-//   НовоеЗначение - Строка - устанавливаемое имя файла.
+//   НовоеЗначение - Строка - устанавливаемое имя файла без расширения.
 //
 //  Возвращаемое значение:
 //   Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
 //
+// Пример:
+//   Совет = Новый СоветДругогоМастера();
+//   Совет.ИмяФайлаСоЗначениямиДеталек("config");
+//   // Теперь будут искаться файлы: config.json, config.yaml, config.yml, config.ini
+//
 Функция ИмяФайлаСоЗначениямиДеталек(НовоеЗначение = Неопределено) Экспорт
 ```
 
 ## ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек
 
 ```bsl
-// Установить/получить относительный путь к каталогу, где хранятся файл со значениями деталек.
+// Установить/получить относительный путь к каталогу, где хранятся файлы со значениями деталек.
+// Этот каталог добавляется к стандартным каталогам поиска конфигурационных файлов.
 //
 // Параметры:
-//   НовоеЗначение - Строка - устанавливаемый путь к каталогу.
+//   НовоеЗначение - Строка - устанавливаемый относительный путь к каталогу.
 //
 //  Возвращаемое значение:
 //   Строка, СоветДругогоМастера - Текущее установленное значение для гетера, ЭтотОбъект для сеттера.
 //
+// Пример:
+//   Совет = Новый СоветДругогоМастера();
+//   Совет.ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек("config");
+//   // Конфигурационные файлы будут искаться также в каталоге "./config"
+//
 Функция ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек(НовоеЗначение = Неопределено) Экспорт
 ```
+
+## Пример использования
+
+```bsl
+// Создание и настройка советника для конфигурации приложения
+Совет = Новый СоветДругогоМастера();
+
+// Установка значений деталек напрямую
+ЗначенияДеталек = Новый Соответствие();
+ЗначенияДеталек.Вставить("app.name", "МоеПриложение");
+ЗначенияДеталек.Вставить("app.version", "1.0.0");
+ЗначенияДеталек.Вставить("database.host", "localhost");
+
+Совет.ЗначенияДеталек(ЗначенияДеталек)
+     .ПрефиксПеременныхСреды("MYAPP_")
+     .ИмяФайлаСоЗначениямиДеталек("application")
+     .ДополнительныйКаталогПоискаФайлаСоЗначениямиДеталек("config");
+
+// Использование в создании поделки
+Поделка = Новый Поделка(Совет);
+```
+
+Данная конфигурация приведет к следующему поведению системы параметров:
+1. Переменные среды с префиксом `MYAPP_` будут загружены в параметры
+2. Файлы `application.json`, `application.yaml`, `application.yml`, `application.ini` будут искаться в стандартных каталогах и каталоге `config`
+3. Значения, установленные напрямую в соответствии, будут иметь наивысший приоритет