如何向用户明确函数的参数在 Matlab 中以字符串形式输入？

Question

我有以下函数，其最后一个参数是文本文件的名称：

function [property_without_headers]=gslib_file_to_matlab_var(nModel,nCell,gslib_file_name) % must enter the last argument, gslib_file_name, in single quotes as its treated as a string

if nargin<3, % making third argument optional (code to be executed even when only 2 arguments are provided)
    gslib_file_name=input('Enter the gslib file name: ','s');
end
if length(gslib_file_name)<4 || ~strcmpi(gslib_file_name(end-3:end),'.dat'),
    gslib_file_name=[gslib_file_name '.dat']; % string concatenation
end

%% Reading directly from the .dat files generated from SGEMS and making the data of file as a variable

property_gslib_format=textread(gslib_file_name,'%f\t','headerlines',nModel+2); 
property_without_headers=reshape(property_gslib_format,nModel,nCell)';

现在，根据一般看法，该函数要输入的最后一个参数是数字。 如何让用户更清楚地知道要输入的最后一个参数（即文本文件的名称）应该采用字符串格式，即用单引号引起来？ 如果我定义了函数如下所示，然后我收到意外的 MATLAB 表达式的错误。：

[property_without_headers]=gslib_file_to_matlab_var(nModel,nCell,'gslib_file_name')

Answer 1

要做的第一件事可能是为该函数编写“帮助”，并明确指出最后一个参数必须是字符串。

您可以使用“ischar()”检查该参数的类型，即：

if ~ischar(gslib_file_name)
    error('gslib_file_name  should a be string');
end

Answer 2

这就是帮助文档的用途，这就是您的功能的最终用户确实会看到。可以在此处找到更多格式建议。

Answer 3

如果您的应用程序不需要仅在控制台上运行，我建议使用 uigetfile< /a> 让用户通过 GUI 对话框窗口选择文件。因此，用户会非常清楚您正在寻找文件名。

因此，你会写

if nargin < 3
     %# ask for a *.dat file
     [fileName,pathName] = uigetfile('*.dat','select gslib file');
     %# check whether the user selected anything
     if fileName == 0
        error('file selection aborted by user')
     end
     %# construct gslib file name from path and file name
     gslib_file_name = fullfile(pathName,fileName);
end

显然，无论如何，很好地记录该函数都会有所帮助。