如何將文檔添加到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