Matlab의 수퍼 클래스에서 문서를 상속하는 방법은 무엇입니까?

Question

저는 몇 가지 광범위한 문서 작업을 수행 한 수퍼 클래스를 보유하고 있습니다. 이 수퍼 클래스에서 상속받은 하위 클래스가 있으며 가능한 경우 수퍼 문서를 다시 사용하고 싶습니다.

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가 : 슈퍼 클래스 ClassA와 예를 들어

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의 도움말 설명을 얻을. 나는 슈퍼의 도움말 설명도 포함 시키길 원합니다. 출력은 다음과 같습니다.

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

@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') 

주/방법이 표시됩니다.

Answer 2

당신이 설명하는 방식으로 문서를 작성하는 경우 사용자가 원하는 것을 얻을 수있는 유일한 방법은 help에 과부하를 지정하여 사용자 지정 작업을 수행하는 것입니다. 예를 들어 오버로드 된 help은 builtin('help') 그 자체를 호출 한 다음 수퍼 클래스의 builtin('help')을 호출 할 수 있습니다.

그러나 표준 방식으로 문서화하지는 않습니다. 일반적으로 속성 바로 위에 주석을 사용하여 속성을 문서화하고 메서드의 함수 시그니처 바로 아래에 주석이있는 메서드를 문서화합니다. 그렇게하면 모든 상속 된 메소드에 대한 도움말이 자동으로 표시됩니다.