matlab - 在构造函数帮助文件中显示用户创建的 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 中的“编辑表”或早期版本中的“编辑容器.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