La traducción de esta página aún no se ha actualizado a la versión más reciente. Haga clic aquí para ver la última versión en inglés.

help

Ayuda para las funciones de la ventana de comandos

contraer todo en la página

Sintaxis

help name
help

Descripción

help name muestra el texto de ayuda para la funcionalidad especificada por name, como una función, un método, una clase, una toolbox, una variable o un espacio de nombres.

ejemplo

help muestra contenido relacionado con sus acciones anteriores.

Ejemplos

contraer todo

Muestre ayuda para la función delete de MATLAB®.

help delete
delete - Delete files or objects
    This MATLAB function deletes filename from disk, without requesting
    verification.

    Syntax
      delete filename
      delete filename1 ... filenameN
      delete ___ ResolveSymbolicLinks=tf
      delete(obj)delete Delete file or graphics object.
...

Dado que delete es el nombre de una función y de varios métodos, el texto de ayuda incluye un enlace a una lista de los métodos con el mismo nombre. Solicite ayuda para el método delete de la clase handle.

help handle/delete
handle/delete - Delete handle object
    This MATLAB function deletes the handle object.

    Syntax
      delete(H)
...

Muestre ayuda para el espacio de nombres containers, la clase Map y el método isKey.

help containers
help containers.Map
help containers.Map.isKey

No todos los espacios de nombres, clases y métodos o eventos asociados requieren una especificación completa. Por ejemplo, muestre el texto de ayuda del método throwAsCaller de la clase MException.

help throwAsCaller

Muestre ayuda para una variable de tipo datetime. Dado que t es de tipo datetime, el comando help muestra un texto de ayuda para la clase datetime.

t = datetime;
help t
--- help for datetime ---

 datetime - Arrays that represent points in time
    The datetime data type represents points in time, such as August 24,
    2020, 10:50:30 a.m.

    Creation
...

Solicite ayuda para Day, un método de la clase datetime.

help t.Day
--- help for datetime/Day ---

 datetime/Day - Day-of-month number
  numeric array
...

Enumere todas las funciones de la carpeta matlabroot/toolbox/matlab/timefun especificando una ruta parcial.

help timefun
Timing functions.
    cputime          - CPU time in seconds.
    tic              - Start stopwatch timer.
    toc              - Stop stopwatch timer.
    etime            - Elapsed time.
    pause            - Wait in seconds.
...

Argumentos de entrada

contraer todo

Nombre de la funcionalidad, como el nombre de una función, método, clase, toolbox o variable, especificado como vector de caracteres o un escalar de cadena. name también puede ser un símbolo de operador (como +).

Si name es una variable, help muestra el texto de ayuda de la clase de esa variable.

Para obtener ayuda para un método de una clase, especifique el nombre de la clase y el nombre del método separados por un punto. Por ejemplo, para obtener ayuda para el método methodname de la clase classname, escriba help classname.methodname.

Algunas clases y otros elementos del espacio de nombres requieren que se especifique el nombre del espacio de nombres. Los eventos, propiedades y algunos métodos requieren que se especifique el nombre de la clase. Separe los componentes del nombre con puntos. Por ejemplo, para obtener ayuda para la propiedad propertyname de la clase classname, escriba classname.propertyname. Para obtener ayuda para la clase classname del espacio de nombres namespacename, escriba namespacename.methodname. Para obtener ayuda para el método methodname de la clase classname en el espacio de nombres namespacename, escriba namespacename.classname.methodname.

Si name aparece en varias carpetas de la ruta de búsqueda de MATLAB, help muestra el texto de ayuda de la primera instancia de name encontrada en la ruta de búsqueda.

Si name está sobrecargado, help muestra un enlace a una lista de los métodos con el mismo nombre.

Si name especifica el nombre o la ruta parcial de una carpeta:

  • Si la carpeta contiene un archivo Contents.m no vacío, la función help muestra el archivo. Contents.m contiene una lista de archivos de programa de MATLAB de la carpeta y sus descripciones.

  • Si la carpeta contiene un archivo Contents.m vacío, la función help muestra name is a folder.

  • Si la carpeta no contiene un archivo Contents.m, la función help enumera la primera línea del texto de ayuda de cada archivo de programa de la carpeta.

  • Si name es el nombre tanto de una carpeta como de otro elemento de la ruta de búsqueda de MATLAB (como un método, una clase, una toolbox o una variable), la función help muestra el texto asociado para el elemento de la ruta de búsqueda y un enlace para mostrar el texto de ayuda para la carpeta.

Sugerencias

  • Para evitar que las descripciones largas se salgan de la pantalla antes de que tenga tiempo de leerlas, introduzca more on y, después, introduzca la instrucción help.

  • Para identificar el nombre del espacio de nombres de una clase, cree una instancia de la clase y, a continuación, llame a class(obj).

Historial de versiones

Introducido antes de R2006a

Consulte también

| | | | |

Temas