Merge pull request #133 from silverbulleters/feature/simple-debug

Удобная отладка + дымовые тесты

doc/PluginsTemplates/ШаблонГенератораОтчета/ШаблонГенератораОтчета/Ext/ObjectModule.bsl

@@ -1,33 +1,70 @@
 Перем ПутьКФайлуПолный Экспорт;// в эту переменную будет установлен правильный клиентский путь к текущему файлу
 
 // { Plugin interface
-Функция ОписаниеПлагина(ВозможныеТипыПлагинов) Экспорт
+
+// Вернуть описание плагина в виде структуры со спец.ключами
+//
+// Параметры:
+//   ВозможныеТипыПлагинов - ФиксированнаяСтруктура -
+//
+//  Возвращаемое значение:
+//   Структура - структура-результат
+//
+Функция ОписаниеПлагина(Знач ВозможныеТипыПлагинов) Экспорт
 	Результат = Новый Структура;
 	Результат.Вставить("Тип", ВозможныеТипыПлагинов.ГенераторОтчета);
 	Результат.Вставить("Идентификатор", Метаданные().Имя);
 	Результат.Вставить("Представление", "");
 	ВызватьИсключение "Необходимо указать представление";
-	
+
 	Возврат Новый ФиксированнаяСтруктура(Результат);
 КонецФункции
 
+// Инициализация плагина
+//
+// Параметры:
+//   КонтекстЯдраПараметр - объект браузера тестов -
+//
 Процедура Инициализация(КонтекстЯдраПараметр) Экспорт
 КонецПроцедуры
+
 // } Plugin interface
 
 // { Report generator interface
+
+// Создать отчет, который будет в функцию "Показать"
+//
+// Параметры:
+//   КонтекстЯдра - Объект - Объект браузера тестов
+//   РезультатыТестирования - Структура, Соответствие -
+//
+//  Возвращаемое значение:
+//   Любой - результат, который будет в функцию "Показать"
+//
 Функция СоздатьОтчет(КонтекстЯдра, РезультатыТестирования) Экспорт
 	ЭтотОбъект.ТипыУзловДереваТестов = КонтекстЯдра.Плагин("ПостроительДереваТестов").ТипыУзловДереваТестов;
 	ЭтотОбъект.СостоянияТестов = КонтекстЯдра.СостоянияТестов;
 	ВызватьИсключение "Метод не реализован";
+	Возврат Неопределено; //Возвращается рельный отчет
 КонецФункции
 
 #Если ТолстыйКлиентОбычноеПриложение Тогда
+// Показать отчет о тестировании на клиенте
+//
+// Параметры:
+//   Отчет - <Тип.Вид> - отчет, ранее возвращенный в функции СоздатьОтчет
+//
 Процедура Показать(Отчет) Экспорт
 	ВызватьИсключение "Метод не реализован";
 КонецПроцедуры
 #КонецЕсли
 
+// Сохранить результаты тестирования в файл
+//
+// Параметры:
+//   Отчет - <Тип.Вид> - <описание параметра>
+//   ПолныйПутьФайла - <Тип.Вид> - <описание параметра>
+//
 Процедура Экспортировать(Отчет, ПолныйПутьФайла) Экспорт
 	ВызватьИсключение "Метод не реализован";
 КонецПроцедуры

doc/PluginsTemplates/ШаблонГенератораОтчета/ШаблонГенератораОтчета/Forms/Форма/Ext/Form/Module.bsl

@@ -2,11 +2,25 @@
 Перем ПутьКФайлуПолный Экспорт;// в эту переменную будет установлен правильный клиентский путь к текущему файлу
 
 // { Plugin interface
+
+// Вернуть описание плагина в виде структуры со спец.ключами
+//
+// Параметры:
+//   ВозможныеТипыПлагинов - ФиксированнаяСтруктура -
+//
+//  Возвращаемое значение:
+//   Структура - структура-результат
+//
 &НаКлиенте
 Функция ОписаниеПлагина(ВозможныеТипыПлагинов) Экспорт
 	Возврат ОписаниеПлагинаНаСервере(ВозможныеТипыПлагинов);
 КонецФункции
 
+// Инициализация плагина
+//
+// Параметры:
+//   КонтекстЯдраПараметр - объект браузера тестов -
+//
 &НаКлиенте
 Процедура Инициализация(КонтекстЯдраПараметр) Экспорт
 КонецПроцедуры
@@ -18,18 +32,40 @@
 // } Plugin interface
 
 // { Report generator interface
+
+// Создать отчет, который будет в функцию "Показать"
+//
+// Параметры:
+//   КонтекстЯдра - Объект - Объект браузера тестов
+//   РезультатыТестирования - Структура, Соответствие -
+//
+//  Возвращаемое значение:
+//   Любой - результат, который будет в функцию "Показать"
+//
 &НаКлиенте
 Функция СоздатьОтчет(КонтекстЯдра, РезультатТестирования) Экспорт
 	Объект.ТипыУзловДереваТестов = КонтекстЯдра.Плагин("ПостроительДереваТестов").Объект.ТипыУзловДереваТестов;
 	Объект.СостоянияТестов = КонтекстЯдра.Объект.СостоянияТестов;
 	ВызватьИсключение "Метод не реализован";
+	Возврат Неопределено; //Возвращается рельный отчет
 КонецФункции
 
+// Показать отчет о тестировании на клиенте
+//
+// Параметры:
+//   Отчет - <Тип.Вид> - отчет, ранее возвращенный в функции СоздатьОтчет
+//
 &НаКлиенте
 Процедура Показать(Отчет) Экспорт
 	ВызватьИсключение "Метод не реализован";
 КонецПроцедуры
 
+// Сохранить результаты тестирования в файл
+//
+// Параметры:
+//   Отчет - <Тип.Вид> - <описание параметра>
+//   ПолныйПутьФайла - <Тип.Вид> - <описание параметра>
+//
 &НаКлиенте
 Процедура Экспортировать(Отчет, ПолныйПутьФайла) Экспорт
 	ВызватьИсключение "Метод не реализован";