如何确定是否调用了函数后跟分号（“;”）？

Question

在一个 Matlab 脚本中，我调用了一个用户定义的函数（m-function）。我的函数在使用disp 和/或fprintf 调用将值打印到命令窗口时返回一个值。

在编写表达式或语句时，将; 放在其末尾以禁止打印。当表达式调用我的函数时，; 可以禁止打印返回值。但是，这不会影响被调用函数内的disp 输出。

我想在适当的时候消除函数的显示输出。 有没有办法确定函数调用是否在以; 结尾的表达式中进行？

Answer 1

我喜欢您尝试做的事情的精神，但我认为这可能与 Matlab 中的常见编程模式背道而驰。正如您正确指出的那样，终止分号的目的是禁止打印返回值。试图让它融入您的其他功能可能需要一些深度黑客攻击和难看的难以维护的代码。实现您所描述的标准方法是通过属性名称-值对参数。例如，Matlab 的优化套件有一个名为'Display' 的属性，可以将其设置为各种值以指示所需的详细程度（请参阅optimset）。

如果您想尝试寻找一种方法来检查终止分号，您可以查看未记录的 mint、mlintmex 和 mtree 函数 – read more here。不幸的是，使用 mlint 来简单地检查“用分号终止语句以抑制输出”警告 (see this function on the MatlabCental File Exchange) 在所有情况下都不起作用，因为函数调用本身不会产生此警告。

更新

这是一个可以插入到被调用函数中的代码尝试，以确定调用者的行是否由分号终止。您应该知道，这尚未经过彻底测试，并且可能非常脆弱。我没有使用子函数或匿名函数对其进行测试，我知道如果您使用 ... 将一行换成多行，它会失败。

st = dbstack('-completenames');  % M-file of caller and line number
caller = st(2);
str = mlint('-lex',caller.file); % Struct containing parsed data

isSemicolon = false; % Assume no semicolon
for i = 1:length(str)
    % Find end-of-line corresponding to function call
    c = strsplit(str(i).message,'/');
    if str2double(c{1}) == caller.line && strcmp(c{2}(end-5:end-1),'<EOL>')
        % Check for comments
        j = i-1;
        if ~isempty(strfind(str(j).message,'%'))
            j = j-1;
        end
        % Check for semicolon
        if strcmp(str(j).message(end-2),';')
            isSemicolon = true; % Semicolon found
            break;
        end
    end
end

换句话说，玩这个来学习，但我不建议实际使用它。

Answer 2

恐怕您的问题的答案是否。该信息根本不会传递给被调用的函数。

您不应该考虑添加分号作为“禁止打印”的手段，而是缺少分号会指示 MATLAB 在函数调用的输出变量上调用 display 函数。换句话说，MATLAB 会解释这段代码：

y = myFunc(x)

作为：

y = myFunc(x);
display(y);

我认为在函数中添加“打印”或“详细”参数是实现所需目标的最佳选择。

Answer 3

我认为实现您想要的结果的最简单方法（即是否显示disp）是添加额外的函数输入或输出。例如，添加一个输入（可选，您可以设置默认行为）：

function y=myFunc(a,displayResults)
if nargin==1
    displayResults=true; %// set the default behaviour
end

%// if you want to print something
if displayResults
    disp(a)
end
end

或者额外的输出。在这种情况下，foo 不会在屏幕上产生任何输出，但所有消息都保存到一个元胞数组中，如果需要，可以访问该数组：

function [x,m] = foo(a)
m={}; %// initialise cell array of output messages

x=a;

m{length(m)+1}=a; %// some message
m{length(m)+1}='another message'; %// another message
end

我认为第一个选项会更好，第二个选项不能很好地处理fprintf，并且显示m 的元素可能会很棘手，具体取决于它包含的内容。第一种方法非常简单，甚至不需要您更改现有代码，因为您可以将displayResults 输入设为可选并将默认设置为您想要的。

Answer 4

这是一个可能的解决方法（要明确 - 这本身并不是问题的真正答案，只是避免不必要行为的一种方法）。说我的功能是：

function y = prt_test(x)
    y = x + 1;
    disp('IN PRT_TEST')
end

调用：

>> % Regular use - message and output are displayed:
>> y = prt_test(1)
IN PRT_TEST
y =
     2

>> % Regular use w/ ";" - only message is displayed:
>> y = prt_test(2);
IN PRT_TEST

>> % Use "evalc()" - message and output are displayed:
>> evalc('y = prt_test(3)')
ans =
IN PRT_TEST
y =
     4

>> % Use "evalc()" w/ func ";" - only message is displayed:
>> evalc('y = prt_test(4);')
ans =
IN PRT_TEST

>> % Use "evalc();" - no output:
>> evalc('y = prt_test(5)');

>> % Use "evalc();" w/ func ";" - no output:
>> evalc('y = prt_test(6);');

>>

Answer 5

您可以通过在函数开头本地重新定义disp 输出来抑制它：

function [] = hideDisplay()
%[
    % Override `disp` behavior
    disp = @(x)doNothing;

    % Next `disp` calls will no longer appear in matlab console
    disp('Hello')
    disp('World!')
%]
end

%% ---
function [] = doNothing()
%[
%]
end