5

私はいくつかの広範なドキュメントを作成したスーパークラスを持っています。このスーパークラスから継承したサブクラスがあり、可能であればスーパーのドキュメントを再利用したいと考えています。たとえば、スーパー クラスの場合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スーパーのヘルプの説明も入れてほしいです。出力は次のようになります。

 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

これを行う方法はありますか？

4

2 に答える 2

2

あなたが説明した方法でドキュメントを書いている場合、あなたが求めているものを得る唯一の方法は、オーバーロードhelpしてカスタマイズしたことを行うことだと思います。たとえば、オーバーロードされたものはそれ自体をhelp呼び出してから、そのスーパークラスを呼び出すことができます。builtin('help')builtin('help')

ただし、標準的な方法で物事を文書化しているわけではありません。通常、プロパティ自体のすぐ上にコメントを使用してプロパティを文書化し、メソッドの関数シグネチャのすぐ下にコメントを使用してメソッドを文書化します。そうすれば、継承されたすべてのメソッドのヘルプが自動的に表示されます。

于 2013-05-07T16:50:58.043 に答える