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.

Añadir ayuda para el programa

Este ejemplo muestra cómo proporcionar ayuda en los programas que escriba. 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 justo debajo de la línea de definición de la función (la línea con la palabra clave function). Si la función contiene un bloque arguments, también puede colocar el texto de ayuda justo debajo del bloque arguments.

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

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 help addme en la línea de comandos, el texto de ayuda se muestra en la ventana de comandos:

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 del texto de ayuda, que a menudo se llama línea H1, suele incluir el nombre del programa y una breve descripción. El explorador de la carpeta actual y las funciones help y lookfor usan la línea H1 para mostrar información acerca del programa.

Cree enlaces See also incluyendo los nombres de la función al final del texto de ayuda en una línea que empieza con % See also. Si la función está presente en la ruta de búsqueda o en la carpeta actual, el comando help muestra cada uno de estos nombres de función como un hipervínculo a su ayuda. De lo contrario, help imprime los nombres de función tal y como aparecen en el texto de ayuda.

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

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

Termine el texto de ayuda con una línea en blanco (sin %). El sistema de ayuda ignora cualquier línea de comentario que aparezca después del bloque de texto de ayuda.

Nota

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

Consulte también

|

Temas relacionados