Matlab带可选输入的函数调用报错：请求排查原因与正确调用方法

我编写了一个MATLAB R2020b的函数my_func，设计为接收三个可选输入参数，未传入时使用脚本内的默认值。函数代码如下：

function my_func(varargin)
    user_inputs = inputParser;
    addOptional(user_inputs, 'input1', getinput1());
    addOptional(user_inputs, 'input2', getinput2());
    addOptional(user_inputs, 'input3', getinput3());
    
    parse(user_inputs, varargin{:});
    input1 = user_inputs.Results.input1;
    input2 = user_inputs.Results.input2;
    input3 = user_inputs.Results.input3; 

    % getinput1()、getinput2()、getinput3()的定义在此处，不影响问题本身
end

无参数调用时函数运行正常，但传入三个位置参数（如my_func('myfirstinput', 'mysecondinput', 'mythirdinput')）或使用名称-值对（如my_func('input1', input1, 'input2', input2, 'input3', input3)）调用时，均出现如下报错：

Error using my_func
Too many input arguments

报错原因 #

问题核心是混淆了inputParser中addOptional和addParameter的用法，以及参数规则冲突：

1. addOptional用于定义位置可选参数，这类参数必须按顺序传入，且不能与名称-值对混合使用。当你尝试用名称-值对调用时，inputParser会将'input1'、input1等视为独立的位置参数，导致参数数量远超addOptional定义的3个，触发"参数过多"报错。
2. 即使是纯位置参数调用，若addOptional的参数规则与实际传入的参数逻辑不匹配，也会引发解析异常。

正确实现与调用方式 #

根据需求选择对应方案：

方案1：仅支持位置可选参数 #

如果希望用户按顺序传入0-3个参数，保持addOptional的用法，调用时必须严格遵循位置顺序：

function my_func(varargin)
    user_inputs = inputParser;
    addOptional(user_inputs, 'input1', getinput1());
    addOptional(user_inputs, 'input2', getinput2());
    addOptional(user_inputs, 'input3', getinput3());
    
    parse(user_inputs, varargin{:});
    input1 = user_inputs.Results.input1;
    input2 = user_inputs.Results.input2;
    input3 = user_inputs.Results.input3; 

    % 后续业务逻辑
end

合法调用示例：

• 无参数：my_func()
• 传入1个参数：my_func('myfirstinput')
• 传入3个参数：my_func('myfirstinput', 'mysecondinput', 'mythirdinput')

方案2：仅支持名称-值对参数 #

如果希望用户可以任意指定参数（无需按顺序），将addOptional替换为addParameter，调用时必须使用参数名+参数值的成对形式：

function my_func(varargin)
    user_inputs = inputParser;
    addParameter(user_inputs, 'input1', getinput1());
    addParameter(user_inputs, 'input2', getinput2());
    addParameter(user_inputs, 'input3', getinput3());
    
    parse(user_inputs, varargin{:});
    input1 = user_inputs.Results.input1;
    input2 = user_inputs.Results.input2;
    input3 = user_inputs.Results.input3; 

    % 后续业务逻辑
end

合法调用示例：

• 无参数：my_func()
• 指定单个参数：my_func('input2', 'mysecondinput')
• 指定所有参数：my_func('input1', input1, 'input2', input2, 'input3', input3)

方案3：同时支持位置可选与名称-值对参数 #

若需要兼容两种调用方式，需开启inputParser的KeepUnmatched属性，允许混合传入位置参数和名称-值对，并手动处理参数覆盖逻辑：

function my_func(varargin)
    user_inputs = inputParser;
    % 定义位置可选参数
    addOptional(user_inputs, 'input1', getinput1());
    addOptional(user_inputs, 'input2', getinput2());
    addOptional(user_inputs, 'input3', getinput3());
    % 保留未匹配的名称-值对参数
    user_inputs.KeepUnmatched = true;
    
    parse(user_inputs, varargin{:});
    
    % 初始化参数为位置可选参数的结果
    input1 = user_inputs.Results.input1;
    input2 = user_inputs.Results.input2;
    input3 = user_inputs.Results.input3; 
    
    % 用名称-值对参数覆盖位置参数的值
    if isfield(user_inputs.Unmatched, 'input1')
        input1 = user_inputs.Unmatched.input1;
    end
    if isfield(user_inputs.Unmatched, 'input2')
        input2 = user_inputs.Unmatched.input2;
    end
    if isfield(user_inputs.Unmatched, 'input3')
        input3 = user_inputs.Unmatched.input3;
    end

    % 后续业务逻辑
end

合法调用示例：

• 位置参数调用：my_func('a', 'b', 'c')
• 名称-值对调用：my_func('input3', 'c')
• 混合调用：my_func('a', 'input2', 'b')（input1为'a'，input2为'b'，input3用默认值）

内容的提问来源于stack exchange，提问作者AmericanJael