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

Question

我想创建一个 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() 可以在不打印其余功能代码的情况下更轻松地实现这一点吗？）

Answer 1

您可以使用 help 的输出来提供函数文档的 text-version

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

可能还值得研究一下 custom documentation，因为 MATLAB 中已经内置了很多方法，可以以简洁明了的方式显示一系列函数的帮助。

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

Store a function's help in a variable in MATLAB

documentation

matlab

printf