Рефакторинг и улучшение документации

Author: Stivo182

README.md

@@ -1,4 +1,3 @@
-
 # BenchmarkOneScript
 
 [![Release](https://img.shields.io/github/release/Stivo182/BenchmarkOneScript.svg)](https://github.com/Stivo182/BenchmarkOneScript/releases)
@@ -18,7 +17,6 @@
 
 Библиотека для измерения производительности кода на OneScript, вдохновлённая [BenchmarkDotNet](https://github.com/dotnet/BenchmarkDotNet/), с поддержкой параметризации, мониторинга памяти и гибкой настройки тестов.
 
-
 ## Возможности
 
 - **Гибкая настройка:** конфигурация тестов через аннотации, программный код и CLI.
@@ -28,7 +26,7 @@
 - **Метрики:** время выполнения (среднее, минимум, максимум), стандартное отклонение и ошибка, операций в секунду (Op/s), квартили и произвольные процентили.
 - **Экспорт результатов:** сохранение результатов выполнения бенчмарков в Markdown, JSON, HTML.
 
-## 🚀 Быстрый старт
+## Быстрый старт
 
 ## 1. Установка
 
@@ -38,7 +36,7 @@ opm install benchmark
 
 ## 2. Создание бенчмарка
 
-Создайте класс с методами, помеченными аннотацией `&Бенчмарк`, где каждый метод реализует тестируемую логику. 
+Создайте класс с методами, помеченными аннотацией `&Бенчмарк`, где каждый метод реализует тестируемую логику.
 В следующем примере мы сравниваем алгоритмы конкатенации строк через оператор `+` и метод `СтрСоединить`:
 
 ```bsl
@@ -79,14 +77,13 @@ opm install benchmark
 **CLI:**
 
 ```bash
-benchos run [OPTIONS] [FILE]
+benchos run КонкатенацияСтрок.os
 ```
 
 **API:**
 
 ```bsl
 #Использовать benchmark
-#Использовать "."
 
 Результат = Бенчмаркинг.Запустить(Тип("КонкатенацияСтрок"));
 ```

docs/CLI.md

@@ -10,21 +10,27 @@ benchos run [OPTIONS] [FILE]
 
 ### Опции
 
-| Опция | Описание | Пример |
-| --- | --- | --- | 
-| `--iterationCount` | Количество измерительных итераций | `--iterationCount 10` |
-| `--iterationTime` | Минимальное время выполнения одной итерации (мс) | `--iterationTime 500` |
-| `--warmupCount` | Количество прогревочных итераций | `--warmupCount 10` |
-| `--invocationCount` | Количество вызовов метода за итерацию | `--invocationCount 100` |
-| `--runtime` | Версии OneScript через запятую (current, stable, dev, x.x.x). | `--runtime dev,stable` |
-| `--throughput` | Стратегия выполнения [`ПропускнаяСпособность`](СтратегииЗапуска.md#пропускная-способность-throughput) | |
-| `--coldstart` | Стратегия выполнения [`ХолодныйЗапуск`](СтратегииЗапуска.md#холодный-запуск-cold-start) | |
-| `-m`, `--memory` | Включить [мониторинг использования памяти](МониторингПамяти.md) | |
-| `-e`, `--exporters` | Форматы [экспорта результатов](ЭкспортРезультатов.md) (`md`, `json`, `html`) | `-e json,html` |
-| `-a`, `--artifacts` | Каталог для сохранения результатов | `-a path/to/file` |
-| `-r`, `--recursive` | Рекурсивный поиск в поддиректориях | |
-| `--settings` | Файл настроек бенчмарков в формате JSON | `--settings path/to/settings.json` |
-| `--debug` | Порт отладки | `--debug 2801` |
+| Опция | Описание | По умолчанию | Пример |
+| --- | --- | --- | --- |
+| `--iterationCount` | Количество измерительных итераций | `15` | `--iterationCount 10` |
+| `--iterationTime` | Минимальное время выполнения одной итерации (мс) | `100` | `--iterationTime 500` |
+| `--warmupCount` | Количество прогревочных итераций | `6` | `--warmupCount 10` |
+| `--invocationCount` | Количество вызовов метода за итерацию (0 = авто) | `0` | `--invocationCount 100` |
+| `--runtime` | Версии OneScript через запятую (`current`, `stable`, `dev`, `x.x.x`) | | `--runtime dev,stable` |
+| `--throughput` | Стратегия выполнения [`ПропускнаяСпособность`](СтратегииЗапуска.md#пропускная-способность-throughput) | | |
+| `--coldstart` | Стратегия выполнения [`ХолодныйЗапуск`](СтратегииЗапуска.md#холодный-запуск-cold-start) | | |
+| `-m`, `--memory` | Включить [мониторинг использования памяти](МониторингПамяти.md) | | |
+| `-e`, `--exporters` | Форматы [экспорта результатов](ЭкспортРезультатов.md) через запятую: `md`, `json`, `html` | | `-e json, html` |
+| `-a`, `--artifacts` | Каталог для сохранения результатов | `.\BenchmarkArtifacts` | `-a path/to/dir` |
+| `-r`, `--recursive` | Рекурсивный поиск в поддиректориях | | |
+| `--settings` | Файл настроек бенчмарков в формате JSON | | `--settings path/to/settings.json` |
+| `--debug` | Порт отладки | | `--debug 2801` |
+
+### Примечания
+
+- Опции `--throughput` и `--coldstart` взаимно исключают друг друга.
+- Значение `--invocationCount 0` включает автоматический расчёт количества вызовов за итерацию.
+- Опции `--warmupCount`, `--invocationCount`, `--iterationTime` игнорируются при стратегии `--coldstart`.
 
 ## Примеры
 
@@ -44,6 +50,9 @@ benchos run /path/to/benchmarks
 # Запуск всех бенчмарков в директории, включая вложенные каталоги
 benchos run -r /path/to/benchmarks
 
-# Рекурсивный запуск с мониторингом памяти и экспортом в JSON
-benchos run -r -m -e json ./benchmarks/
+# Рекурсивный запуск с мониторингом памяти и экспортом в JSON и HTML
+benchos run -r -m -e 'json, html' ./benchmarks/
+
+# Холодный запуск с 10 итерациями
+benchos run --coldstart --iterationCount 10 /path/to/МойКласс.os
 ```

docs/БыстрыйСтарт.md

@@ -8,7 +8,7 @@ opm install benchmark
 
 ## 2. Создание бенчмарка
 
-Создайте класс с методами, помеченными аннотацией `&Бенчмарк`, где каждый метод реализует тестируемую логику. 
+Создайте класс с методами, помеченными аннотацией `&Бенчмарк`, где каждый метод реализует тестируемую логику.
 В следующем примере мы сравниваем алгоритмы конкатенации строк через оператор `+` и метод `СтрСоединить`:
 
 ```bsl
@@ -42,21 +42,21 @@ opm install benchmark
 	Текст = СтрСоединить(МассивПодстрок);
 КонецПроцедуры
 ```
+
 ## 3. Запуск бенчмарков
 
 Запустите бенчмарки одним из следующих способов:
 
 **CLI:**
 
 ```bash
-benchos run [OPTIONS] [FILE]
+benchos run КонкатенацияСтрок.os
 ```
 
 **API:**
 
 ```bsl
 #Использовать benchmark
-#Использовать "."
 
 Результат = Бенчмаркинг.Запустить(Тип("КонкатенацияСтрок"));
 ```

docs/ЗапускБенчмарков.md

@@ -8,7 +8,7 @@ benchos run [OPTIONS] [FILE]
 
 Подробнее см. в разделе [CLI](CLI.md).
 
-### Примеры использования
+### Примеры
 
 ```bash
 # Запуск по имени класса (файл МойКласс.os должен существовать в текущей директории)
@@ -47,7 +47,7 @@ benchos run -r -m -e json ./benchmarks/
 ```bsl
 ДескрипторыБенчмарков = Новый КоллекцияДескрипторовБенчмарков(Тип("МойКласс"));
 
-// Запуск конкретного бенчмарка
+// Запуск конкретного бенчмарка по имени
 ДескрипторБенчмарка = ДескрипторыБенчмарков.НайтиПоИмени("МойБенчмарк");
 Результат = Бенчмаркинг.Запустить(ДескрипторБенчмарка);
 
@@ -60,10 +60,10 @@ benchos run -r -m -e json ./benchmarks/
 
 ```bsl
 // Запуск из каталога
-Результат = Бенчмаркинг.ЗапуститьИзКаталога("/path/to/benchmarks");
+Результаты = Бенчмаркинг.ЗапуститьИзКаталога("/path/to/benchmarks");
 
 // Запуск из каталога, включая вложенные каталоги
-Результат = Бенчмаркинг.ЗапуститьИзКаталога("/path/to/benchmarks", Истина);
+Результаты = Бенчмаркинг.ЗапуститьИзКаталога("/path/to/benchmarks", Истина);
 ```
 
 ### Запуск с передачей конфигурации
@@ -84,4 +84,9 @@ benchos run -r -m -e json ./benchmarks/
 // ...
 
 Результат = Бенчмаркинг.Запустить(Тип("МойКласс"), Конфигурация);
+
+// Запуск из каталога с конфигурацией, которая объединяется с приоритетом с конфигурацией каждого бенчмарка
+Конфигурация = Новый КонфигурацияБенчмарков();
+Конфигурация.УстановитьКоличествоИтераций(10);
+Результаты = Бенчмаркинг.ЗапуститьИзКаталога("/path/to/benchmarks", Истина, Конфигурация);
 ```