Main Content

为类创建帮助

doc 命令显示的帮助文本

当您使用 doc 命令显示类的帮助时,MATLAB® 会自动显示其从类定义获得的信息。

例如,创建一个名为 someClass.m 的具有多个属性和方法的类定义文件,如下所示。

classdef someClass
    % someClass Summary of this class goes here
    %   Detailed explanation goes here
    
    properties
        One     % First public property
        Two     % Second public property
    end
    properties (Access=private)
        Three   % Do not show this property
    end
      
    methods
        function obj = someClass
            % Summary of constructor
        end
        function myMethod(obj)
            % Summary of myMethod
            disp(obj)
        end
    end
    methods (Static)
        function myStaticMethod
            % Summary of myStaticMethod
        end
    end
    
end

使用 doc 命令查看类定义中的帮助文本和详细信息。

doc someClass

Help text for someClass including the class name, class summary and detailed explanation, class details, list of constructors, list of public properties, and list of methods

自定义帮助文本

您可以添加有关 doc 命令和 help 命令均包括在其显示中的类的信息。doc 命令在生成的 HTML 页的顶部、从类定义获得的信息之上显示帮助文本。help 命令在命令行窗口中显示帮助文本。有关详细信息,请参阅:

通过在紧随文件中 classdef 语句之后的行上包括注释来为类创建帮助文本。例如,创建一个名为 myClass.m 的文件,如下所示。

classdef myClass
    % myClass   Summary of myClass
    % This is the first line of the description of myClass.
    % Descriptions can include multiple lines of text.
    %
    % myClass Properties:
    %    a - Description of a
    %    b - Description of b
    %
    % myClass Methods:
    %    doThis - Description of doThis
    %    doThat - Description of doThat

    properties
        a
        b
    end
    
    methods
        function obj = myClass
        end
        function doThis(obj)
        end
        function doThat(obj)
        end
    end
    
end

初始注释块中的属性和方法的列表和说明是可选的。如果您的注释行包含类名称且后跟 PropertiesMethods 以及一个冒号 (:),则 MATLAB 将创建指向这些属性或方法的帮助的超链接。

使用 help 命令在命令行窗口中查看类的帮助文本。

help myClass
  myClass   Summary of myClass
  This is the first line of the description of myClass.
  Descriptions can include multiple lines of text.
 
  myClass Properties:
     a - Description of a
     b - Description of b

  myClass Methods:
     doThis - Description of doThis
     doThat - Description of doThat 

方法

通过在函数定义语句后插入注释来为方法创建帮助。例如,修改类定义文件 myClass.m 以包括 doThis 方法的帮助。

       function doThis(obj)
        % doThis  Do this thing
        %   Here is some help text for the doThis method.
        %
        %   See also DOTHAT.
        
        disp(obj)
        end        

使用 help 命令在命令行窗口中查看方法的帮助文本。指定类名称和方法名称,用点分隔开。

help myClass.doThis
  doThis  Do this thing
    Here is some help text for the doThis method.

    See also doThat.

属性

可通过两种方法为属性创建帮助:

  • 在属性定义上方插入注释行。将此方法用于多行帮助文本。

  • 在属性定义旁边添加一行注释。

定义上方的注释比定义旁边的注释具有更高的优先级。

例如,修改类定义文件 myClass.m 中的属性定义。

    properties
        a          % First property of myClass

        % b - Second property of myClass
        % The description for b has several 
        % lines of text.
        b          % Other comment
    end

使用 help 命令在命令行窗口中查看属性的帮助。指定类名称和属性名称,用点分隔开。

help myClass.a
 a -  First property of myClass
help myClass.b
  b - Second property of myClass
  The description for b has several 
  lines of text.

枚举

和属性一样,可通过两种方法为枚举创建帮助:

  • 在枚举定义上方插入注释行。将此方法用于多行帮助文本。

  • 在枚举定义旁边添加一行注释文本。

定义上方的注释比定义旁边的注释具有更高的优先级。

例如,在名为 myEnumeration.m 的文件中创建一个枚举类。

classdef myEnumeration
    enumeration
        uno,         % First enumeration

        % DOS - Second enumeration
        % The description for DOS has several 
        % lines of text.
        dos          % A comment (not help text)
    end
end

使用 help 命令在命令行窗口中查看帮助。指定类名称和枚举成员,用点分隔开。

help myEnumeration.uno
uno -  First enumeration
help myEnumeration.dos
  dos - Second enumeration
  The description for dos has several 
  lines of text.

事件

和属性和枚举一样,可通过两种方法为事件创建帮助:

  • 在事件定义上方插入注释行。将此方法用于多行帮助文本。

  • 在事件定义旁边添加一行注释文本。

定义上方的注释比定义旁边的注释具有更高的优先级。

例如,在名为 hasEvents.m 的文件中创建一个类。

classdef hasEvents < handle
   events
       Alpha     % First event

       % Beta - Second event
       % Additional text about second event.
       Beta      % (not help text)
   end
   
   methods
       function fireEventAlpha(h)
           notify(h,'Alpha')
       end
       
       function fireEventBeta(h)
           notify(h,'Beta')
       end
   end
end

使用 help 命令在命令行窗口中查看帮助。指定类名称和事件,用点分隔开。

help hasEvents.Alpha
 Alpha -  First event
help hasEvents.Beta
  Beta - Second event
  Additional text about second event.

另请参阅

|

相关主题