Документация

Функциональные объекты

Чтобы задать информацию для функции, создайте свойство, которое совпадает с именем функции. Его значение является объектом подписи.

{
  "functionName1": { signatureObj1 },
  "functionName2": { signatureObj2 }
}

Чтобы задать информацию для метода класса или функции пакета, используйте полное имя функции или метода. Свойствами в качестве примера является "MyClass.myMethod" или "myPackage.myFunction". Можно задать несколько функциональных подписей для той же функции путем определения нескольких функциональных объектов с тем же свойством (имя функции). Для получения дополнительной информации смотрите Несколько Подписей.

Объекты подписи

Объект подписи задает аргументы ввода и вывода и поддерживаемые платформы для функции. Значение каждого свойства, за исключением свойства platforms, является массивом объектов аргумента.

{
  "functionName1":
  {
     "inputs": [ argumentObj1, argumentObj2 ]
  }
}

Каждая подпись может включать следующие свойства.

Объекты аргумента

Объекты аргумента задают информацию для каждого из аргументов ввода и вывода.

{
  "functionName1":
  {
     "inputs":
     [
        {"name":"in1",  "kind":"required", "type":["numeric"]},
        {"name":"in2",  "kind":"required", "type":["numeric","integer","scalar"]}
     ]
  }
}

Порядок, что входные параметры появляются в файле JSON, является значительным. Например, в вызове функции functionName1, in1 должен появиться перед in2.

Каждый объект аргумента может включать следующие свойства.

 имя Имя аргумента

 kind – Вид аргумента

 ввод Класс и/или атрибуты аргумента

 Аргумент repeating - Specify многократно

 purpose – Описание аргумента

Для более сложных функциональных подписей следующие свойства доступны для каждого объекта аргумента.

 platforms – Список поддерживаемых платформ

 tuple – Определение набора аргументов

 mutuallyExclusiveGroup – Определение набора исключительных аргументов

Файл подписи Создания функции

Этот пример описывает, как создать предложения пользовательского кода и завершения для функции.

% myFunc  Example function
% This function is called with any of these syntaxes:
%
%   myFunc(in1, in2) accepts 2 required arguments. 
%   myFunc(in1, in2, in3) also accepts an optional 3rd argument. 
%   myFunc(___, NAME, VALUE) accepts one or more of the following name-value pair 
%       arguments. This syntax can be used in any of the previous syntaxes.
%           * 'NAME1' with logical value
%           * 'NAME2' with 'Default', 'Choice1', or 'Choice2'
function myFunc(reqA,reqB,varargin)
    % Initialize default values
    NV1 = true;
    NV2 = 'Default';
    posA = [];
    
    if nargin > 3
        if rem(nargin,2)
            posA = varargin{1};
            V = varargin(2:end);
        else
            V = varargin;
        end
        for n = 1:2:size(V,2)
            switch V{n}
                case 'Name1'
                    NV1 = V{n+1};
                case 'Name2'
                    NV2 = V{n+1}
                otherwise
                    error('Error.')
            end
        end
    end
end

{
  "_schemaVersion": "1.0.0",
  "myFunc":
  {
     "inputs":
     [
        {"name":"in1", "kind":"required", "type":["numeric"], "purpose":"ID of item"},
        {"name":"in2", "kind":"required", "type":["numeric"], "purpose":"# Items"},
        {"name":"in3", "kind":"ordered", "type":["numeric"], "purpose":"Input Value"},
        {"name":"Name1", "kind":"namevalue", "type":["logical","scalar"],"purpose":"Option"},
        {"name":"Name2", "kind":"namevalue", "type":["char", "choices={'Default','Choice1','Choice2'}"]}
     ]
  }
}

Несколько подписей

Если функция имеет много синтаксисов, может быть полезно для предложений кода сгруппировать синтаксисы как несколько функциональных подписей (независимо от реализации функции). Чтобы обеспечить предложения кода и завершения для нескольких подписей, создайте несколько функциональных объектов с тем же свойством в файле JSON.

Рассмотрите следующую функцию, которая следует за различными путями выполнения кода в зависимости от класса второго входа. Эта функция представлена как пример для предложений кода, и, поэтому, не выполняет вычислений или проверки ошибок.

function anotherFunc(arg1,arg2,arg3)
    switch class(arg2)
        case 'double'
            % Follow code path 1
        case {'char','string'}
            % Follow code path 2
        otherwise
            error('Invalid syntax.')
    end
end

С точки зрения предложений кода рассмотрите функцию как наличие двух функциональных подписей. Первая подпись принимает два необходимых числовых значения. Вторая подпись принимает необходимое числовое, сопровождаемый символом или строкой, и наконец необходимое числовое. Чтобы задать несколько функциональных подписей, задайте несколько функциональных объектов в файле JSON с тем же свойством (имя функции).

{
  "_schemaVersion": "1.0.0",
  "anotherFunc":
  {
     "inputs":
     [
        {"name":"input1",  "kind":"required", "type":["numeric"]},
        {"name":"input2",  "kind":"required", "type":["numeric"]}
     ]
  },
  "anotherFunc":
  {
     "inputs":
     [
        {"name":"input1",  "kind":"required", "type":["numeric"]},
        {"name":"input2",  "kind":"required", "type":[["char"],["string"]]},
        {"name":"input3",  "kind":"required", "type":["numeric"]}
     ]
  }
}

Также можно задать несколько функциональных подписей с помощью свойства mutuallyExclusiveGroup объекта аргумента. Как правило, это легче и более читаемо, чтобы реализовать несколько функциональных объектов, но использование взаимоисключающих групп включает повторное использование общих объектов аргумента, таких как input1.

{
  "_schemaVersion": "1.0.0",
  "anotherFunc":
  {
     "inputs":
     [
        {"name":"input1",  "kind":"required", "type":["numeric"]},
        {"mutuallyExclusiveGroup":
          [
            [
              {"name":"input2",  "kind":"required", "type":["numeric"]}
            ],
            [
              {"name":"input2",  "kind":"required", "type":[["char"],["string"]]},
              {"name":"input3",  "kind":"required", "type":["numeric"]}
            ]
           ]
        }
     ]
  }
}