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帮助系统不会自动为您执行此操作，您需要自己保持帮助是最新的。如果你正确地格式化了类帮助，它会被神奇地超链接 - 尝试＆＃34;编辑表＆＃34;在R2013b或＆＃34;编辑containers.Map＆＃34;在早期版本中，看看可以做些什么。

另请注意，您可以单独从构造函数中记录类，如下所示：

%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

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

1 个答案: