Skip to content

Commit

Permalink
#7 Скорректирована документаци по перечислениям.
Browse files Browse the repository at this point in the history
  • Loading branch information
khorevaa committed Feb 9, 2018
1 parent fcad92a commit 86b6b77
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 40 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,14 +160,13 @@ $ opm install -f <ПутьКФайлу>
* Строка
* Число
* Дата
* Длительность (в работе)

Также опция может принимать массивы данных типов, например:

* МассивЧисел
* МассивСтрок
* МассивДат
* МассивДлительностей (в работе)
* Перечисление

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

Expand All @@ -191,9 +190,21 @@ $ opm install -f <ПутьКФайлу>
.СкрытьВСправке(); // Любой тип
```

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

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

```bsl
ЦветКонсоли = Команда.Опция("c color", "green" ,"Описание опции")
.ТПеречисление() // тип опции перечисление
.Перечисление("green", Новый ЗеленыйЦвет(), "Консоль будет зеленого цвета")
.Перечисление("red", Цвета.Красный, "Консоль будет красного цвета")
.Перечисление("Случайный", СлучайныйЦвет(), "Консоль будет случайного цвета")
;
```

Перечисление ограничивает пользователя в выборе значения опции, при этом разработчик для каждой опции может задавать свой тип значения

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

## Пример синтаксиса опций
Expand Down Expand Up @@ -248,6 +259,7 @@ $ opm install -f <ПутьКФайлу>
* МассивЧисел
* МассивСтрок
* МассивДат
* Перечисление (см. пример опций)

Пример `Строки` аргумента:

Expand Down
81 changes: 65 additions & 16 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@
- [ТМассивДат](#тмассивдат)
- [ТМассивЧисел](#тмассивчисел)
- [ТМассивСтрок](#тмассивстрок)
- [ТПеречисление](#тперечисление)
- [Перечисление](#перечисление)
- [Описание](#описание-1)
- [ПодробноеОписание](#подробноеописание-2)
- [Псевдоним](#псевдоним)
- [Обязательный](#обязательный)
- [ВФайле](#вфайле)
Expand Down Expand Up @@ -623,7 +626,7 @@
// СтрокаПеременнаяОкружения - строка - имя переменной окружения, откуда получать значение
// допустимо использование нескольких переменных окружения через пробел
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### СкрытьВСправке
Expand All @@ -633,7 +636,7 @@
// возвращает текущий параметр команды
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### ПоУмолчанию
Expand All @@ -646,7 +649,7 @@
// ВходящееЗначение - произвольный - значение параметра по умолчанию
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### Флаговый
Expand All @@ -656,7 +659,7 @@
// возвращает текущий параметр команды
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
// Вызов необязателен, автоматически определяется при создании параметра,
// если передано значение по умолчанию
```
Expand All @@ -668,7 +671,7 @@
// возвращает текущий параметр команды
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
// Вызов необязателен, автоматически определяется при создании параметра,
// если передано значение по умолчанию
```
Expand All @@ -680,7 +683,7 @@
// возвращает текущий параметр команды
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
// Вызов необязателен, автоматически определяется при создании параметра,
// если передано значение по умолчанию
```
Expand All @@ -695,7 +698,7 @@
// ФорматДаты - Строка - формат даты, при приведении к дате из строки параметра по умолчанию (yyyy-MM-dd_HH:mm:ss)
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
// Вызов необязателен, автоматически определяется при создании параметра,
// если передано значение по умолчанию
```
Expand All @@ -707,7 +710,7 @@
// возвращает текущий параметр команды
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
// Вызов необязателен, автоматически определяется при создании параметра,
// если передано значение по умолчанию
```
Expand All @@ -719,7 +722,7 @@
// возвращает текущий параметр команды
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
// Вызов необязателен, автоматически определяется при создании параметра,
// если передано значение по умолчанию
```
Expand All @@ -735,7 +738,7 @@
// ВходящийРазделительМассива - символ - используется для разделения параметров при парсинге строки
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### ТМассивЧисел
Expand All @@ -748,7 +751,7 @@
// ВходящийРазделительМассива - символ - используется для разделения параметров при парсинге строки
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### ТМассивСтрок
Expand All @@ -761,7 +764,40 @@
// ВходящийРазделительМассива - символ - используется для разделения параметров при парсинге строки
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### ТПеречисление

```bsl
// Функция устанавливает тип параметра "Перечисление"
// возвращает текущий параметр команды
//
// Параметры:
// ДоступныеПеречисления - Соответсвие
// Ключ - Строка
// Значение - Структура ("Наименование, Значение, ДополнительнаяСправка")
// Возвращаемое значение:
// ПараметрКоманды - значение из переменной ЭтотОбъект
// Вызов необязателен, автоматически определяется при создании параметра,
// если передано значение по умолчанию
```

##### Перечисление

```bsl
// Функция устанавливает произвольный тип параметра
// возвращает текущий параметр команды
//
// Параметры:
// НаименованиеПеречисления - строка - пользовательное значение перечисления
// ЗначениеПеречисления - произвольный - системное значение перечисления
// ДополнительнаяСправкаПеречисления - строка - дополнительная строка для справки
//
// Возвращаемое значение:
// ПараметрКоманды - значение из переменной ЭтотОбъект
//
```

##### Описание
Expand All @@ -774,9 +810,22 @@
// НовыеОписание - строка - строка с новым описанием, отличным от переданного в момент создания
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### ПодробноеОписание

```bsl
// Функция устанавливает подробное описание параметра для справки
// возвращает текущий параметр команды
//
// Параметры:
// ВходящееПодробноеОписание - строка - строка с новым описанием, отличным от переданного в момент создания
//
// Возвращаемое значение:
// ПараметрКоманды - значение из переменной ЭтотОбъект
//
```
##### Псевдоним

```bsl
Expand All @@ -787,7 +836,7 @@
// СтрокаПсевдонима - строка - строка с новым псевдонимом, отличным от переданного в момент создания
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### Обязательный
Expand All @@ -800,7 +849,7 @@
// Признак - булево - признак обязательности указания данного параметра (по умолчанию Истина)
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```

##### ВФайле
Expand Down Expand Up @@ -829,5 +878,5 @@
// ВходящийТипЭлементаПараметра - Тип - тип элементов значения параметра, если тип Массив
//
// Возвращаемое значение:
// ЭтотОбъект - класс ПараметрКоманды
// ПараметрКоманды - значение из переменной ЭтотОбъект
```
Loading

0 comments on commit 86b6b77

Please sign in to comment.