如何为Matlab包添加文档说明？

Question

假设我有以下文件结构：

+mypackage/
  foo.m
  bar.m

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

在Python中，我只需要在__init__.py中添加文档字符串。这里的等效方法是什么？

- Eric

---

请参阅：创建帮助摘要文件。 - sco1

Matlab的页面陷入了一个登录重定向循环，无法为我加载。 - Eric

请调整您的浏览器设置。MATLAB的文档不需要登录。 - sco1

@excaza：这不是浏览器设置的问题，而是由MathWorks留下的cookie导致其混淆。无论如何，我在那里推动的是一个非链接答案。 - Eric

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

- sco1