A estas alturas de la película sabemos todos ya que documentar nuestro código es una buena idea. También sabemos que Matlab asume que un comentario que se inicie en la primera línea de un script o justo debajo de la definición de una función es la documentación del archivo en cuestión.
Refresquémonos la memoria. Por ejemplo, si definimos una función así (he cogido una que tenía yo por ahí):
function x = euler_1gdl(data, ci, N, h)
% Computes time response of 1dof system using forward Euler
end
Y hacemos:
>>> help FUNCIÓN
Nos apacerá lo siguiente:
>> help euler_1gdl
Computes time response of 1dof system using forward Euler
Fácil y eficaz. ¡Pues hoy he aprendido tres cosas que no sabía sobre esta historia!
Lo primero es que si ponemos el nombre de la función en mayúsculas aparezce en negrita en la descripción, que bueno tampoco es la repera pero ayuda a que se vea mejor.
Lo segundo y más chulo es que se puede crear una sección en la que se enlacen funciones similares o relacionadas. Simplemente añadimos una línea que empiece por See also seguido con el nombre en mayúsculas de la función a enlazar:
% See also OTRA_FUNCIÓN
Si la función está en alguna de las rutas que Matlab ve (¡el path!) creará él solito el enlace. Aparte de esto, podemos poner hipervínculos en nuestra docu usando HTML para decir dónde se puede encontrar más información.
Va un ejemplo con las tres cosas:
function x = euler_1gdl(data, ci, N, h)
% Computes time response of 1dof system using forward Euler
% x = EULER_1GDL([m,c,k], [x0,v0], N, h)
% See also ODE45
%
% More information can be found <a href="https://en.wikipedia.org/wiki/Euler_method">on Wikipedia</a>
end
Que nos muestra esto:
No está mal, ¿eh? Lo que no sé es si esto mismo puede replicarse en Octave, no lo tengo a mano ahora mismo. Si alguno ha probado que comente, porfis
Referencias
Add Help for Your Program en MathWorks
Ondiz
All Jonkman Microblog content and data are available under the Creative Commons Attribution 3.0 license.