From aca3efb3275cf70d0c3b83b5ed6ab940260d6a9e Mon Sep 17 00:00:00 2001 From: Artur Ayukhanov Date: Sat, 23 Nov 2024 14:04:18 +0300 Subject: [PATCH] =?UTF-8?q?=D0=98=D1=81=D0=BF=D1=80=D0=B0=D0=B2=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=D1=8B=20=D0=BC=D0=B5=D0=BB=D0=BA=D0=B8=D0=B5=20?= =?UTF-8?q?=D1=81=D0=B8=D0=BD=D1=82=D0=B0=D0=BA=D1=81-=D0=BF=D1=80=D0=BE?= =?UTF-8?q?=D0=B1=D0=BB=D0=B5=D0=BC=D1=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b46d293..6252e1c 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Короткое название библиотеки `cli` -Данная библиотека для языка OScript, позволяет создавать консольные приложения с разбором и проверкой аргументов. +Данная библиотека для языка OScript позволяет создавать консольные приложения с разбором и проверкой аргументов. [Документация и описание публичного API](docs/readme.md) ## Быстрый старт @@ -31,7 +31,7 @@ Приложение.УстановитьОсновноеДействие(ЭтотОбъект) Приложение.Запустить(АргументыКоманднойСтроки); -КонецПроцедуры // ВыполнениеКоманды() +КонецПроцедуры Процедура ВыполнитьКоманду(Знач Команда) Экспорт @@ -70,7 +70,7 @@ Приложение.Запустить(АргументыКоманднойСтроки); -КонецПроцедуры // ВыполнениеКоманды() +КонецПроцедуры Процедура ВыполнитьКоманду(Знач КомандаПриложения) Экспорт КомандаПриложения.ВывестиСправку(); @@ -106,7 +106,7 @@ Приложение.Запустить(АргументыКоманднойСтроки); -КонецПроцедуры // ВыполнениеКоманды() +КонецПроцедуры /////////////////////////////////////////////////////// @@ -172,7 +172,7 @@ $ opm install -f <ПутьКФайлу> ``` -Либо, скачать библиотеку с помощью opm: +Либо скачать библиотеку с помощью opm: opm install cli @@ -220,7 +220,7 @@ $ opm install -f <ПутьКФайлу> Приложение.Запустить(АргументыКоманднойСтроки); ``` -Этот вызов является "точкой входа" в консольное приложение. В общем случае, после него уже не идет никакого дополнительного кода. Парсер анализирует аргументы и запускает команды автоматически. +Этот вызов является "точкой входа" в консольное приложение. В общем случае после него уже не идет никакого дополнительного кода. Парсер анализирует аргументы и запускает команды автоматически. ## Параметры команд/приложения @@ -228,7 +228,7 @@ $ opm install -f <ПутьКФайлу> * Опция * Аргумент -В общем случае, Опции имеют имена, аргументы являются позиционными. Кроме того, по умолчанию указание опций необязательно, а аргументов - обязательно. Это можно переопределить, но дефолтное поведение именно такое. Аргумент - обязателен, опция - нет. +В общем случае, опции имеют имена, аргументы являются позиционными. Кроме того, по умолчанию указание опций необязательно, а аргументов - обязательно. Это можно переопределить, но дефолтное поведение именно такое. Аргумент - обязателен, опция - нет. ## Опция @@ -246,7 +246,7 @@ $ opm install -f <ПутьКФайлу> * МассивБулево * Перечисление -Для простых типов поддерживается определение типа по значение по умолчанию. Пример, +Для простых типов поддерживается определение типа значения по умолчанию. Пример: ```bsl Отладка = Команда.Опция("f force", ,"Описание опция") @@ -268,7 +268,7 @@ $ opm install -f <ПутьКФайлу> .СкрытьВСправке(); // Любой тип ``` -`ВОкружении` Возможна передача нескольких переменных окружения разделенных через **пробел** +`ВОкружении` Возможна передача нескольких переменных окружения, разделенных через **пробел** Пример `перечисления` опции: @@ -320,7 +320,7 @@ $ opm install -f <ПутьКФайлу> * Число * Дата -Для простых типов поддерживается определение типа по значение по умолчанию. Пример, +Для простых типов поддерживается определение типа значения по умолчанию. Пример: ```bsl Отладка = Команда.Аргумент("PATH", "" ,"Описание аргумента") @@ -349,7 +349,7 @@ $ opm install -f <ПутьКФайлу> .СкрытьВСправке(); // Любой тип ``` -`ВОкружении` Возможна передача нескольких переменных окружения разделенных через **пробел** +`ВОкружении` Возможна передача нескольких переменных окружения, разделенных через **пробел** Подробное описание возможностей параметров команд и приложения [](./docs/ПараметрКоманды.md) @@ -446,7 +446,7 @@ cli поддерживает автоматическую инициализац Правила наименования аргументов, имя должно содержать только символы в верхнем регистре: -Пример, использования аргументов в определении строки использования приложения +Пример использования аргументов в определении строки использования приложения ```bsl Команда.Спек="SRC DST" ``` @@ -470,7 +470,7 @@ cli позволяет произвольно настраивать поряд ## Необязательность -Для того, чтобы сделать аргументы или опции необязательными, их необходимо заключить в `[...]`: +Чтобы сделать аргументы или опции необязательными, их необходимо заключить в `[...]`: ```bsl Команда.Спек = "[-x]"; ``` @@ -562,12 +562,12 @@ cli позволяет произвольно настраивать поряд Повтор аргумента | '...' | Конец повтора аргументов | '--' | -Можно комбинировать в указанные символы как хочется, для того чтобы добиться любых необходимых проверок опций и аргументов. +Можно комбинировать в указанные символы как хочется, чтобы добиться любых необходимых проверок опций и аргументов. ## Строка использования по умолчанию -По умолчанию, если не установлена разработчиком иная, cli автоматически создает для приложения и каждой команды строки использования, используя следующую логику: +По умолчанию, если разработчиком не установлена иная, cli автоматически создает для приложения и каждой команды строки использования, используя следующую логику: * Начало с пустой строки * Если определена хоть одна опция, добавляется `[OPTIONS]` или `[ОПЦИИ]` к текущей строке использования