Введите синтаксический анализатор для функций
Объект inputParser
позволяет вам управлять входными параметрами к функции путем создания входной схемы синтаксического анализатора. Чтобы проверять вход, можно задать функции валидации для обязательных аргументов, дополнительных аргументов и аргументов пары "имя-значение". Опционально, можно установить свойства настроить поведение парсинга, такое как обработка чувствительности к регистру, входных параметров массива структур и входных параметров, которые не находятся во входной схеме синтаксического анализатора.
После определения вашей входной схемы синтаксического анализатора вызовите функцию parse
. inputParser
хранит информацию о входных параметрах.
Введите имена и значения | Где сохранено |
---|---|
Соответствие с входной схемой синтаксического анализатора | Свойство Results |
Не переданный функции и, поэтому, присвоенные значения по умолчанию | Свойство UsingDefaults |
Никакое соответствие не ввело схему синтаксического анализатора | Свойство Unmatched |
p = inputParser
создает входной объект синтаксического анализатора со значениями свойств по умолчанию.p
= inputParser
addOptional | Добавьте дополнительный, позиционный параметр во входную схему синтаксического анализатора |
addParameter | Добавьте дополнительный аргумент пары "имя-значение" во входную схему синтаксического анализатора |
addRequired | Добавьте требуемый, позиционный параметр во входную схему синтаксического анализатора |
parse | Анализ входных параметров функции |
addParamValue | (Не рекомендуемый), Добавляет дополнительный аргумент пары "имя-значение" во входную схему синтаксического анализатора |
Можно задать входную схему синтаксического анализатора путем вызова addRequired
, addOptional
и функций addParameter
в любом порядке. Однако, когда вы вызываете функцию, которая использует входной синтаксический анализатор, аргументы передаются в этом порядке:
Обязательные аргументы
Любые дополнительные, позиционные параметры
Любые пары "имя-значение"
Аргументы, добавленные к входной схеме синтаксического анализатора с функцией addOptional
, позиционны. Поэтому добавьте их во входную схему синтаксического анализатора в том же порядке, они передаются в функцию.
Используйте addOptional
, чтобы добавить отдельный аргумент во входную схему синтаксического анализатора. Если вы хотите проанализировать дополнительную пару "имя-значение", то используйте функцию addParameter
.