如何将文档添加到matlab包中？

Question

说我有以下文件结构：

+mypackage/
  foo.m
  bar.m

如何为help(mypackage)的输出添加帮助？

在python中，我只需在__init__.py中添加一个docstring。这里的等价物是什么？

Answer 1

根据MATLAB的toolbox distribution documentation，Python的__init__.py文档字符串的MATLAB类似于help summary file。

使用上述文件夹结构，我们可以添加contents.m文件以实现所需的行为：

+mypackage/
  foo.m
  bar.m
  contents.m

给出一个基本的contents.m文件：

% This is contents.m
% This package contains:
%     bar - Bar things
%     foo - Foo things

我们实现了以下目标：

>> help mypackage
  This is contents.m
  This package contains:
      bar - Bar things
      foo - Foo things