Создание справки для классов

Помощь тексту из документа Команда

Когда вы используете 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

Пользовательский текст справки

Можно добавить информацию о классах это оба 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

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

Смотрите также

doc | help

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