MATLAB中怎样书写函数的帮助文档

Posted 2022-04-14 昊虹算法

运用MATLAB编程时，我们经常查询别人书写的函数或模块帮助文档，比如下面这篇博文就详细介绍了如何查看函数或模块的帮助文档：
https://blog.csdn.net/hehe1994/article/details/115801001
我们在书写自己的函数时，为了方便别人调用或者自己以后阅读，也应养成书写帮助文档的好习惯，那么怎么书写呢？
很简单，在函数的定义行之下的注释都是帮助文档。
举例如下：

function [ result ] = sm_a_plus_b(a,b)
% 这是一个关于MATLAB函数编写的示例
% 这个程序用于实现a+b，并返回其相加结果

result=a+b;

end

注意，m文件的标题要和函数名一致，这样MATLAB才能正常调用，如下图所示：

运行结果如下：

>> help sm_a_plus_b
  这是一个MATLAB函数编写示例
  这个程序用于实现a+b，并返回其相加结果