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.

Agregue ayuda para su programa

Este ejemplo muestra cómo proporcionar ayuda para los programas que escribe. El texto de ayuda aparece en la ventana de comandos cuando se utiliza la función.help

Cree texto de ayuda insertando comentarios al principio del programa. Si el programa incluye una función, coloque el texto de ayuda inmediatamente debajo de la línea de definición de función (la línea con la palabra clave).function

Por ejemplo, cree una función en un archivo llamado que incluya texto de ayuda:addme.m

function c = addme(a,b) % ADDME  Add two values together. %   C = ADDME(A) adds A to itself. % %   C = ADDME(A,B) adds A and B together. % %   See also SUM, PLUS.  switch nargin     case 2         c = a + b;     case 1         c = a + a;     otherwise         c = 0; end

Al escribir en la línea de comandos, el texto de ayuda se muestra en la ventana de comandos:help addme

addme  Add two values together.
    C = addme(A) adds A to itself.

    C = addme(A,B) adds A and B together.
 
    See also sum, plus.

La primera línea de texto de ayuda, a menudo llamada línea H1, normalmente incluye el nombre del programa y una breve descripción. El navegador de la carpeta actual y las funciones utilizan la línea H1 para mostrar información sobre el programa.helplookfor

Cree vínculos mediante la inclusión de nombres de función al final del texto de ayuda en una línea que empiece por.See also% See also Si la función existe en la ruta de búsqueda o en la carpeta actual, el comando muestra cada uno de estos nombres de función como un hipervínculo a su ayuda.help De lo contrario, imprime los nombres de las funciones tal y como aparecen en el texto de ayuda.help

Puede incluir hipervínculos (en forma de URL) a sitios web en el texto de ayuda. Crear hipervínculos mediante la inclusión de un elemento de anclaje HTML.<a></a> Dentro del delimitador, utilice una instrucción para ejecutar un comando.matlab:web Por ejemplo:

% For more information, see <a href="matlab:  % web('https://www.mathworks.com')">the MathWorks Web site</a>.

Finalice el texto de ayuda con una línea en blanco (sin una).% El sistema de ayuda ignora las líneas de comentario que aparecen después del bloque de texto de ayuda.

Nota

Cuando varios programas tienen el mismo nombre, el comando determina el texto de ayuda que se mostrará aplicando las reglas descritas en.helpOrden de precedencia de función Sin embargo, si un programa tiene el mismo nombre que una función, la opción en los menús contextuales siempre muestra la documentación de la función.MathWorks®Help on SelectionMathWorks

Consulte también

|

Temas relacionados