Документация

Классы

Создание текста справки для классов путем включения комментариев к строкам сразу после 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

Списки и описания свойств и методов в первоначальном блоке комментариев являются необязательными. Если включить строки комментария, содержащие имя класса, за которым следует Properties или Methods и двоеточие (:), то 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.