在构造函数帮助文件中显示用户创建的MATLAB对象的可用方法

Question

我想向我在MATLAB中创建的对象（称之为"myobject"）添加一个帮助文件，但我也希望在键入"help myobject"时显示该对象可用的方法

例如，如果我将代码的帮助部分留空，那么键入"help myobject"将产生：

>> help myobject
myobject methods:
mymethod1             - This is the first method available for myobject
mymethod2             - This is the second available method for myobject

然而，如果我在构造函数中添加文本来解释对象是什么以及应该如何使用它，那么键入"help-myobject"会产生：

>> help myobject
This is the text telling you about myobject and how it should be used.

我希望既能有描述myobject的书面文本，也能对myobject可用的方法进行实时查询。

Answer 1

不幸的是，MATLAB帮助系统不会自动为您提供帮助，您需要自己保持帮助的最新状态。如果你正确地格式化了类帮助，它就会神奇地被超链接——试试R2013b中的"edit table"或早期版本中的"edit containers.Map"，看看能做些什么。

还需要注意的是，您可以将类与构造函数分开进行文档化，如下所示：

%MYOBJECT - object of mine
%   This is the class help
%   more class help...
%
%   MYOBJECT methods:
%      doStuff - does stuff   
%
% See also myobject/myobject.
classdef myobject
    methods
        function obj = myobject(arg1, arg2)
        %MYOBJECT - construct my object
        %   OBJ = MYOBJECT(ARG1) builds an object based on ARG1.
        %
        %   OBJ = MYOBJECT(ARG1,ARG2) builds an object based on ARG1 and ARG2.
        ...
        end
    end
end

然后你可以做

>> help myobject % class help
>> help myobject/myobject % constructor help