Main Content

Agregar ayuda para su programa

En este ejemplo se muestra cómo proporcionar ayuda para 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 comienzo del programa. Si su 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). Si la función contiene un bloque de arguments, también puede colocar el texto de ayuda inmediatamente debajo del bloque de arguments.

Por ejemplo, cree una función en un archivo denominado 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

Cuando escribe 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, denominada a menudo línea H1, incluye habitualmente el nombre del programa y una breve descripción. El explorador Current Folder y las funciones help y lookfor utilizan la línea H1 para mostrar información sobre el programa.

Cree enlaces See also incluyendo los nombres de función al final del texto de ayuda en una línea que comience con % See also. Si la función existe en la ruta de búsqueda o en la carpeta actual, el comando help se muestra en cada uno de los nombres de función como un hipervínculo a su ayuda. De lo contrario, help imprime los nombres de función 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, utilice 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>.

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

Nota

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

Consulte también

|

Temas relacionados

Sitios web externos