Skip to content

Commit

Permalink
Исправлены мелкие синтакс-проблемы
Browse files Browse the repository at this point in the history
  • Loading branch information
artbear authored Nov 23, 2024
1 parent d861858 commit aca3efb
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Короткое название библиотеки `cli`

Данная библиотека для языка OScript, позволяет создавать консольные приложения с разбором и проверкой аргументов.
Данная библиотека для языка OScript позволяет создавать консольные приложения с разбором и проверкой аргументов.

[Документация и описание публичного API](docs/readme.md)
## Быстрый старт
Expand All @@ -31,7 +31,7 @@
Приложение.УстановитьОсновноеДействие(ЭтотОбъект)
Приложение.Запустить(АргументыКоманднойСтроки);
КонецПроцедуры // ВыполнениеКоманды()
КонецПроцедуры
Процедура ВыполнитьКоманду(Знач Команда) Экспорт
Expand Down Expand Up @@ -70,7 +70,7 @@
Приложение.Запустить(АргументыКоманднойСтроки);
КонецПроцедуры // ВыполнениеКоманды()
КонецПроцедуры
Процедура ВыполнитьКоманду(Знач КомандаПриложения) Экспорт
КомандаПриложения.ВывестиСправку();
Expand Down Expand Up @@ -106,7 +106,7 @@
Приложение.Запустить(АргументыКоманднойСтроки);
КонецПроцедуры // ВыполнениеКоманды()
КонецПроцедуры
///////////////////////////////////////////////////////
Expand Down Expand Up @@ -172,7 +172,7 @@
$ opm install -f <ПутьКФайлу>
```

Либо, скачать библиотеку с помощью opm:
Либо скачать библиотеку с помощью opm:

opm install cli

Expand Down Expand Up @@ -220,15 +220,15 @@ $ opm install -f <ПутьКФайлу>
Приложение.Запустить(АргументыКоманднойСтроки);
```

Этот вызов является "точкой входа" в консольное приложение. В общем случае, после него уже не идет никакого дополнительного кода. Парсер анализирует аргументы и запускает команды автоматически.
Этот вызов является "точкой входа" в консольное приложение. В общем случае после него уже не идет никакого дополнительного кода. Парсер анализирует аргументы и запускает команды автоматически.

## Параметры команд/приложения

Все параметры разделяются на два типа:
* Опция
* Аргумент

В общем случае, Опции имеют имена, аргументы являются позиционными. Кроме того, по умолчанию указание опций необязательно, а аргументов - обязательно. Это можно переопределить, но дефолтное поведение именно такое. Аргумент - обязателен, опция - нет.
В общем случае, опции имеют имена, аргументы являются позиционными. Кроме того, по умолчанию указание опций необязательно, а аргументов - обязательно. Это можно переопределить, но дефолтное поведение именно такое. Аргумент - обязателен, опция - нет.

## Опция

Expand All @@ -246,7 +246,7 @@ $ opm install -f <ПутьКФайлу>
* МассивБулево
* Перечисление

Для простых типов поддерживается определение типа по значение по умолчанию. Пример,
Для простых типов поддерживается определение типа значения по умолчанию. Пример:

```bsl
Отладка = Команда.Опция("f force", ,"Описание опция")
Expand All @@ -268,7 +268,7 @@ $ opm install -f <ПутьКФайлу>
.СкрытьВСправке(); // Любой тип
```
`ВОкружении` Возможна передача нескольких переменных окружения разделенных через **пробел**
`ВОкружении` Возможна передача нескольких переменных окружения, разделенных через **пробел**

Пример `перечисления` опции:

Expand Down Expand Up @@ -320,7 +320,7 @@ $ opm install -f <ПутьКФайлу>
* Число
* Дата

Для простых типов поддерживается определение типа по значение по умолчанию. Пример,
Для простых типов поддерживается определение типа значения по умолчанию. Пример:

```bsl
Отладка = Команда.Аргумент("PATH", "" ,"Описание аргумента")
Expand Down Expand Up @@ -349,7 +349,7 @@ $ opm install -f <ПутьКФайлу>
.СкрытьВСправке(); // Любой тип
```

`ВОкружении` Возможна передача нескольких переменных окружения разделенных через **пробел**
`ВОкружении` Возможна передача нескольких переменных окружения, разделенных через **пробел**

Подробное описание возможностей параметров команд и приложения [](./docs/ПараметрКоманды.md)

Expand Down Expand Up @@ -446,7 +446,7 @@ cli поддерживает автоматическую инициализац

Правила наименования аргументов, имя должно содержать только символы в верхнем регистре:

Пример, использования аргументов в определении строки использования приложения
Пример использования аргументов в определении строки использования приложения
```bsl
Команда.Спек="SRC DST"
```
Expand All @@ -470,7 +470,7 @@ cli позволяет произвольно настраивать поряд

## Необязательность

Для того, чтобы сделать аргументы или опции необязательными, их необходимо заключить в `[...]`:
Чтобы сделать аргументы или опции необязательными, их необходимо заключить в `[...]`:
```bsl
Команда.Спек = "[-x]";
```
Expand Down Expand Up @@ -562,12 +562,12 @@ cli позволяет произвольно настраивать поряд
Повтор аргумента | '...' |
Конец повтора аргументов | '--' |

Можно комбинировать в указанные символы как хочется, для того чтобы добиться любых необходимых проверок опций и аргументов.
Можно комбинировать в указанные символы как хочется, чтобы добиться любых необходимых проверок опций и аргументов.


## Строка использования по умолчанию

По умолчанию, если не установлена разработчиком иная, cli автоматически создает для приложения и каждой команды строки использования, используя следующую логику:
По умолчанию, если разработчиком не установлена иная, cli автоматически создает для приложения и каждой команды строки использования, используя следующую логику:

* Начало с пустой строки
* Если определена хоть одна опция, добавляется `[OPTIONS]` или `[ОПЦИИ]` к текущей строке использования
Expand Down

0 comments on commit aca3efb

Please sign in to comment.