Skip to content

Commit 1f739aa

Browse files
Stivo182Stivo182
committed
docs: Документирование аннотаций
1 parent ef7d004 commit 1f739aa

13 files changed

+159
-20
lines changed

‎src/BenchmarkOneScript/annotations/Классы/АннотацияКатегория.os‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Аннотация задает категорию для группировки бенчмарков в отчетах.
2+
// Позволяет логически объединять тесты по функциональности, типу нагрузки или другим критериям.
3+
//
4+
// Применяется только к методам бенчмарков.
5+
//
6+
// Пример:
7+
// &Бенчмарк
8+
// &Категория("Имя категории")
9+
// Процедруа Бенчмарк() Экспорт
10+
// // ...
11+
// КонецПроцедуры
12+
&Аннотация("Категория")
13+
Процедура ПриСозданииОбъекта()
14+
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияПараметры.os‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
// Задает параметры для бенчмарка, позволяя запускать тесты с разными наборами входных данных.
2+
//
3+
// Метод бенчмарка будет выполнен для каждой уникальной комбинации значений параметров.
4+
// Позволяет анализировать производительность в зависимости от входных условий.
5+
//
6+
// Применяется к публичным полям класса и к методам бенчмарков.
7+
//
8+
// Пример:
9+
// &Параметры(Истина, Ложь)
10+
// Перем Флаг Экспорт;
11+
//
12+
// &Параметры(100, 10)
13+
// &Параметры(200, 20)
14+
// Процедруа Бенчмарк(П1, П2)
15+
// // ...
16+
// КонецПроцедуры
117
&Аннотация("Параметры")
218
Процедура ПриСозданииОбъекта()
319
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияПеред.os‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
// Аннотация указывает, что метод должен быть выполнен перед запуском бенчмарка.
2+
//
3+
// Пример:
4+
// // Параметры:
5+
// // ДескрипторБенчмарка - ДескрипторБенчмарка
6+
// // ПараметрыМетода - Массив из Произвольный
7+
// &Перед
8+
// Процедруа Перед(ДескрипторБенчмарка, ПараметрыМетода) Экспорт
9+
// // ...
10+
// КонецПроцедуры
111
&Аннотация("Перед")
212
Процедура ПриСозданииОбъекта()
313
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияПосле.os‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
// Аннотация указывает, что метод должен быть выполнен после запуска бенчмарка.
2+
//
3+
// Пример:
4+
// // Параметры:
5+
// // ДескрипторБенчмарка - ДескрипторБенчмарка
6+
// &После
7+
// Процедруа После(ДескрипторБенчмарка) Экспорт
8+
// // ...
9+
// КонецПроцедуры
110
&Аннотация("После")
211
Процедура ПриСозданииОбъекта()
312
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияСортировкаОтБыстрыхКМедленным.os‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
// Аннотация задает порядок сортировки результатов в отчете бенчмарков от самых быстрых к самым медленным.
2+
//
3+
// Применяется только к методу ПриСозданииОбъекта.
4+
//
5+
// Пример:
6+
// &СортировкаОтБыстрыхКМедленным
7+
// Процедруа ПриСозданииОбъекта()
8+
// // ...
9+
// КонецПроцедуры
110
&Аннотация("СортировкаОтБыстрыхКМедленным")
211
Процедура ПриСозданииОбъекта()
312
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияСортировкаОтМедленныхКБыстрым.os‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
// Аннотация задает порядок сортировки результатов в отчете бенчмарков от самых медленных к самым быстрым.
2+
//
3+
// Применяется только к методу ПриСозданииОбъекта.
4+
//
5+
// Пример:
6+
// &СортировкаОтМедленныхКБыстрым
7+
// Процедруа ПриСозданииОбъекта()
8+
// // ...
9+
// КонецПроцедуры
110
&Аннотация("СортировкаОтМедленныхКБыстрым")
211
Процедура ПриСозданииОбъекта()
312
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияСортировкаПоМетоду.os‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
// Аннотация задает порядок сортировки результатов в отчете бенчмарков по наименованию метода бенчмарка.
2+
//
3+
// Применяется только к методу ПриСозданииОбъекта.
4+
//
5+
// Пример:
6+
// &СортировкаПоМетоду
7+
// Процедруа ПриСозданииОбъекта()
8+
// // ...
9+
// КонецПроцедуры
110
&Аннотация("СортировкаПоМетоду")
211
Процедура ПриСозданииОбъекта()
312
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияСтратегияПропускнаяСпособность.os‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
// Аннотация задает стратегию измерения "ПропускнаяСпособность".
2+
//
3+
// Особенности стратегии:
4+
// - Автоматический расчет количества вызовов за итерацию
5+
// - Запуск прогревочных итераций
6+
//
7+
// Применяется только к методу ПриСозданииОбъекта.
8+
//
9+
// Пример:
10+
// &СтратегияПропускнаяСпособность
11+
// Процедруа ПриСозданииОбъекта()
12+
// // ...
13+
// КонецПроцедуры
114
&Аннотация("СтратегияПропускнаяСпособность")
215
Процедура ПриСозданииОбъекта()
316
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияСтратегияХолодныйЗапуск.os‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
// Аннотация задает стратегию измерения "ХолодныйЗапуск".
2+
//
3+
// Особенности стратегии:
4+
// - Количество вызовов за итерацию = 1
5+
// - Отсутствуют прогревочные итерации
6+
//
7+
// Применяется только к методу ПриСозданииОбъекта.
8+
//
9+
// Пример:
10+
// &СтратегияХолодныйЗапуск
11+
// Процедруа ПриСозданииОбъекта()
12+
// // ...
13+
// КонецПроцедуры
114
&Аннотация("СтратегияХолодныйЗапуск")
215
Процедура ПриСозданииОбъекта()
316
КонецПроцедуры

‎src/BenchmarkOneScript/annotations/Классы/АннотацияЭталон.os‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
// Аннотация указывает, что метод бенчмарка является эталонным.
2+
//
3+
// Результаты выполнения эталонного бенчмарка используются как базовая метрика
4+
// для оценки эффективности других тестов.
5+
//
6+
// Применяется только к методам бенчмарков.
7+
//
8+
// Пример:
9+
// &Бенчмарк
10+
// &Эталон
11+
// Процедруа Бенчмарк() Экспорт
12+
// // ...
13+
// КонецПроцедуры
114
&Аннотация("Эталон")
215
Процедура ПриСозданииОбъекта()
316
КонецПроцедуры

0 commit comments

Comments
 (0)