Prog25: Cómo documentar funciones

Curso de Introducción a la programación
Cómo documentar funciones
Vídeo anterior	Siguiente vídeo
Este artículo es una unidad didáctica del Curso de Introducción a la Programación

Si no sabemos cómo se usa un comando o función en Octave UPM, siempre podemos usar el comando help para que nos muestre la ayuda. ¿Podemos hacer que nuestras funciones tengan también un texto de ayuda? En este vídeo explicamos cómo escribir este texto de ayuda. Esta actividad se conoce como documentar nuestras funciones, y es una de las actividades fundamentales para lograr que nuestros programas sean útiles, reutilizables y fáciles de entender (por otras personas, y por nosotros mismos cuando los volvamos a leer en el futuro).

2 Para saber más

• Add help for your program (MATLAB)

3 Código

function [s, err] = MiRaiz(A, nPasos)
% Calcula una aprox. de la raiz cuadrada
% 
% Uso; [s, err] = MiRaiz(n, nPasos)
%
% s      es la raiz aproximada de n
% err    es el error de la aproximacion (opcional)
%
% nPasos es el num. de pasos de la aprox.
%        (opcional, por defecto es 10)

  if nargin == 1
    nPasos = 10;
  end

  % Algoritmo
  L = A; W = 1;

  for k=1:nPasos
    L = (L + W)/2;
    W = A/L;
  end

  % Salida
  s = L;
  if nargout > 1
    err = s - sqrt(A);
  end
end

4 Vídeos relacionados

• Prog20: Funciones