Jak dziedziczę dokumentację od superklatek w Matlab?

Question

Mam super klasę, na której zrobiłem obszerną dokumentację. Istnieją podklasy, które dziedziczą z tej super klasy i chciałbym ponownie użyć dokumentacji super, jeśli to możliwe. Na przykład z super klasy 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 

a podklasy 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 

Jeśli wpisuję help ClassB mam tylko ClassB „s opis pomocy. Chcę również dołączyć opis pomocy Super. Dane wyjściowe wyglądają mniej więcej tak:

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 

Czy istnieje sposób, aby to zrobić?

Answer 1

Jak odnotowano w dokumencie @SamRoberts, istnieje dokumentacja właściwości i metod.

Na przykład:

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 

i

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 

Teraz w linii poleceń, można powiedzieć:

Można się ładnie sformatowany hiperłączy.

Pamiętaj również, co otrzymasz z doc Derived (lub gdy podświetlasz słowo i naciskasz F1). To wewnętrznie wywołuje help2html, aby przekonwertować pomoc na HTML. Na przykład, możemy to zrobić sami:

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

Zauważ, że odziedziczone właściwości/metody są wyświetlane.

Answer 2

Jeśli piszesz dokumentację w sposób opisywany, myślę, że jedynym sposobem uzyskania tego, o co prosisz, jest przeciążenie help w celu zrobienia czegoś dostosowanego. Na przykład Twój przeciążony help może sam wywołać builtin('help'), a następnie builtin('help') na swojej nadklasie.

Jednak nie dokumentujesz rzeczy w standardowy sposób; Zazwyczaj dokumentowałbyś właściwości za pomocą komentarzy bezpośrednio nad samą właściwością, a także dokumentowałeś metody z komentarzami bezpośrednio pod sygnaturą funkcji metody. Jeśli to zrobiłeś, automatycznie wyświetliłbyś pomoc dla wszystkich dziedziczonych metod.