doc: описание методов

bia-technologies · Sep 22, 2024 · 6be136f · 6be136f
1 parent 0e5b087
commit 6be136f
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 5 deletions.
diff --git a/exts/yaxunit/src/CommonModules/ЮТМетаданные/Module.bsl b/exts/yaxunit/src/CommonModules/ЮТМетаданные/Module.bsl
@@ -307,6 +307,17 @@
 
 КонецФункции
 
+// Возвращает описание регистра движений документа.
+//
+// Параметры:
+//  Документ     - ДокументСсылка, ДокументОбъект, ДокументМенеджер - Документ или менеджер
+//               - ОбъектМетаданных, Тип - Метаданные или тип документа
+//               - Строка - Полное имя объекта метаданных 
+//  ИмяРегистра  - Строка - Имя регистра движений.
+//
+// Возвращаемое значение:
+//  Структура - Описание регистра движений документа
+//  Неопределено - Документ не делает движений по указанному регистру
 Функция ОписаниеРегистраДвиженийДокумента(Документ, ИмяРегистра) Экспорт
 
 	ПолноеИмяРегистра = Неопределено;
@@ -315,6 +326,7 @@
 		Возврат Неопределено;
 	КонецЕсли;
 
+	//@skip-check constructor-function-return-section
 	Возврат ОписаниеОбъектаМетаданных(ПолноеИмяРегистра);
 
 КонецФункции

diff --git a/exts/yaxunit/src/CommonModules/ЮТТестовыеДанные/Module.bsl b/exts/yaxunit/src/CommonModules/ЮТТестовыеДанные/Module.bsl
@@ -838,12 +838,12 @@
 // ОбработкаОбъект.ЮТКонструкторТестовыхДанных - Конструктор создания тестовых данных для указанного объекта метаданных.
 //
 // Пример:
-// Конструктор = КонструкторОбъекта("Справочники.Товары");
-// Конструктор.Установить("Наименование", "Товар 1");
-// Конструктор.Установить("Цена", 100);
-// Конструктор.Записать(); // Создает товар с наименованием "Товар 1" и ценой 100.
+// Конструктор = ЮТест.Данные().КонструкторОбъекта("Справочники.Товары") // Используя формат текучих выражений
+//   .Установить("Наименование", "Товар 1")
+//   .Установить("Цена", 100)
+//   .Записать(); // Создает товар с наименованием "Товар 1" и ценой 100.
 //
-// Конструктор = КонструкторОбъекта(Документы.ПриходТоваров);
+// Конструктор = ЮТест.Данные().(Документы.ПриходТоваров); // Без использования текучих выражений
 // Конструктор.Установить("Организация", Справочники.Организации.ПустаяСсылка());
 // Конструктор.Установить("Склад", Справочники.Склады.ПустаяСсылка());
 // Конструктор.Установить("Товар", Справочники.Товары.ПустаяСсылка());
@@ -855,6 +855,27 @@
 
 КонецФункции
 
+// Возвращает конструктор создания движений для указанного документа и регистра.
+//
+// Конструктор имеет ряд особенностей:
+//
+// * Создание движений происходит при вызове метода `Записать`, а заполнение реквизитов движений осуществляется через методы установки.
+// * При использовании на клиенте все значения должны быть сериализуемыми.
+//
+// Параметры:
+//  Документ - ДокументОбъект, ДокументСсылка - Документ, для которого создаются движения.
+//  ИмяРегистра - Строка - Имя регистра, движения которого необходимо создать.
+//
+// Возвращаемое значение:
+// ОбработкаОбъект.ЮТКонструкторТестовыхДанных - Конструктор для создания движений по указанному документу и регистру.
+//
+// Пример:
+// Конструктор = КонструкторДвижений(Документы.РеализацияТоваров.СоздатьДокумент(), "Продажи")
+//   .ДобавитьСтроку()
+//   .Установить("Номенклатура", Справочники.Номенклатура.НайтиПоНаименованию("Товар 1"))
+//   .Фикция("Склад")
+//   .Установить("Количество", 10)
+//   .Записать(); // Создает движение реализации товаров.
 Функция КонструкторДвижений(Документ, ИмяРегистра) Экспорт
 
 	Возврат ЮТКонструкторТестовыхДанныхСлужебный.ИнициализироватьКонструкторДвижений(Документ, ИмяРегистра);