在MATLAB中将函数的帮助存储在变量中

时间:2017-01-30 13:12:33

标签: matlab documentation printf

我想创建一个html文件来打印包含一个文件夹中所有功能的讲义。有没有办法以编程方式访问每个功能'帮助以准备字符串输入?

在这样的程序中我正在思考虚构getfunchelp()的内容:

Functions=dir('*.m');

fid = fopen('FunctionSummary.htm','a');
fprintf(fid, ['<HTML><HEAD><TITLE> Function Summary </TITLE>\n']);

for ii=1:length(Functions)

   FunctionName=Functions(ii).name;
   FunctionHelp=getfunchelp(FunctionName); % <= This one over here

   fprintf(fid, ['<H2>',FunctionName,'</H2>']);
   fprintf(fid, ['\n<BR><i>',FunctionHelp,'</i> ']); 
    %... 

end

 fclose(fid);

或者有更好的方法吗? (publish()可以在不打印其余功能代码的情况下轻松实现这一目标吗?)

1 个答案:

答案 0 :(得分:5)

您可以使用help的输出来提供该功能文档的文本版本

helpstr = help(Functions(ii).name);

可能值得研究custom documentation,因为MATLAB中已经内置了很多方法,可以很好地显示一系列函数的帮助。