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

Question

说我有以下文件结构：

+mypackage/
  foo.m
  bar.m

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

在python中，我只需在__init__.py添加一个docstring。 这相当于什么？

Answer 1

根据MATLAB的工具箱分发文档 ，MATLAB类似于Python的__init__.py文档字符串将是一个帮助摘要文件 。

使用上面的文件夹结构，我们可以添加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