如何从 Matlab 中的超类继承文档？

Question

我有一个 Super 类，我已经完成了一些广泛的文档。有从这个超类继承的子类，如果可能的话，我想重用超类的文档。例如超级类ClassA：

classdef ClassA
    %CLASSA Super Class for all others classes
    %
    % CLASSA Properties:
    %   Prop1       It's the first property
    %   Prop2       It's the second
    %
    % CLASSA Methods:
    %   Method1     It's a method
    %   Method2     It's another method

    function value = Method1(var)
        % Super implementation of Method1
    end

    % Other method definitions follow
end

还有一个子类，ClassB：

classdef ClassB < ClassA
    %CLASSB Subclass of super class CLASSA
    %
    % CLASSB Properties:
    %   Prop3       It's the first property of subclass
    %   
    % CLASSB Methods:
    %   Method 3    It's the first method of subclass

    function value = Method1(var)
        % Subclass implementation of Method1
    end

    % Other method definitions follow
end

如果我输入help ClassB，我只会得到ClassB 的帮助说明。我希望也包含 Super 的帮助说明。输出看起来像这样：

 CLASSB Subclass of super class CLASSA

 CLASSB Properties:
    Prop1       It's the first property
    Prop2       It's the second
    Prop3       It's the first property of subclass

 CLASSB Methods:
    Method1     It's a method
    Method2     It's another method
    Method3     It's the first method of subclass

有没有办法做到这一点？

Answer 1

如果您以您描述的方式编写文档，我认为获得所需内容的唯一方法是重载 help 以进行定制。例如，重载的help 可以对其自身调用builtin('help')，然后对其超类调用builtin('help')。

但是，您没有以标准方式记录事物；通常，您会在属性本身的正上方使用 cmets 记录属性，并在方法的函数签名正下方使用 cmets 记录方法。如果你这样做了，那么你会自动显示所有继承方法的帮助。

Answer 2

正如@SamRoberts 所指出的，有一个standard way 记录属性和方法。

例如：

classdef Super
    %Super Summary of this class goes here
    %   Detailed explanation goes here
    %
    % Super Properties:
    %    One - Description of One
    %    Two - Description of Two
    %
    % Super Methods:
    %    myMethod - Description of myMethod
    %

    properties
        One     % First public property
        Two     % Second public property
    end
    properties (Access=private)
        Three   % Do not show this property
    end

    methods
        function obj = Super
            % Summary of constructor
        end
        function myMethod(obj)
            % Summary of myMethod
            disp(obj)
        end
    end
    methods (Static)
        function myStaticMethod
            % Summary of myStaticMethod
        end
    end

end

和

classdef Derived < Super
    %Derived Summary of this class goes here
    %   Detailed explanation goes here
    %
    % See also: Super

    properties
        Forth     % Forth public property
    end

    methods
        function obj = Derived
            % Summary of constructor
        end
        function myOtherMethod(obj)
            % Summary of myMethod
            disp(obj)
        end
    end

end

现在在命令行上，你可以说：

您会得到格式精美的超链接。

还要注意您使用doc Derived 得到的结果（或者当您突出显示单词并按F1 时）。这在内部调用 help2html 将帮助转换为 HTML。例如，我们可以自己这样做：

>> %doc Derived
>> web(['text://' help2html('Derived')], '-noaddressbox', '-new')

注意显示继承的属性/方法。