Esta página aún no se ha traducido para esta versión. Puede ver la versión más reciente de esta página en inglés.

Crear ayuda para clases

Texto de ayuda del comando doc

Cuando se utiliza el comando para mostrar la ayuda de una clase, muestra automáticamente la información que deriva de la definición de clase.docMATLAB®

Por ejemplo, cree un archivo de definición de clase denominado con varias propiedades y métodos, como se muestra.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

Vea el texto de ayuda y los detalles de la definición de clase mediante el comando.doc

doc someClass

Texto de ayuda personalizado

Puede agregar información sobre las clases que el comando y el comando incluyen en sus pantallas.dochelp El comando muestra el texto de ayuda en la parte superior de las páginas HTML generadas, por encima de la información derivada de la definición de clase.doc El comando muestra el texto de ayuda en la ventana de comandos.help Para obtener más información, consulte:

Clases

Crear texto de ayuda para las clases mediante la inclusión de comentarios en las líneas inmediatamente después de la instrucción en un archivo.classdef Por ejemplo, cree un archivo con el nombre, como se muestra.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

Las listas y descripciones de las propiedades y los métodos en el bloque de comentario inicial son opcionales. Si incluye líneas de comentario que contengan el nombre de clase seguido de o y dos puntos (), a continuación, crea hipervínculos a la ayuda para las propiedades o métodos.PropertiesMethods:MATLAB

Vea el texto de ayuda de la clase en la ventana de comandos mediante el comando.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 

Métodos

Crear ayuda para un método insertando comentarios inmediatamente después de la instrucción de definición de función. Por ejemplo, modifique el archivo de definición de clase para incluir la ayuda para el método.myClass.mdoThis

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

Vea el texto de ayuda del método en la ventana de comandos mediante el comando.help Especifique el nombre de la clase y el nombre del método, separados por un punto.

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

    See also doThat.

Propiedades

Hay dos formas de crear ayuda para las propiedades:

  • Inserte líneas de comentario por encima de la definición de propiedad. Utilice este enfoque para el texto de ayuda de varias líneas.

  • Agregue un Comentario de una sola línea junto a la definición de la propiedad.

Los comentarios anteriores a la definición tienen precedencia sobre un comentario junto a la definición.

Por ejemplo, modifique las definiciones de propiedad en el archivo de definición de clase.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

Vea la ayuda para las propiedades en la ventana de comandos mediante el comando.help Especifique el nombre de la clase y el nombre de la propiedad, separados por un punto.

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. 

Enumeraciones

Al igual que las propiedades, hay dos formas de crear ayuda para las enumeraciones:

  • Inserte líneas de comentario por encima de la definición de enumeración. Utilice este enfoque para el texto de ayuda de varias líneas.

  • Agregue un Comentario de una sola línea junto a la definición de enumeración.

Los comentarios anteriores a la definición tienen precedencia sobre un comentario junto a la definición.

Por ejemplo, cree una clase de enumeración en un archivo denominado.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

Vea la ayuda en la ventana de comandos con el comando.help Especifique el nombre de clase y el miembro de enumeración, separados por un punto.

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

Eventos

Al igual que las propiedades y las enumeraciones, hay dos maneras de crear ayuda para los eventos:

  • Inserte líneas de comentario por encima de la definición del evento. Utilice este enfoque para el texto de ayuda de varias líneas.

  • Agregue un Comentario de una sola línea junto a la definición del evento.

Los comentarios anteriores a la definición tienen precedencia sobre un comentario junto a la definición.

Por ejemplo, cree una clase en un archivo con el nombre.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

Vea la ayuda en la ventana de comandos con el comando.help Especifique el nombre de clase y el evento, separados por un punto.

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

Consulte también

|

Temas relacionados