Erlang en ejemplos 2

Para quienes han tenido que documentar su código saben que es un proceso que puede llevar más tiempo que el necesario. En lenguajes como Java contamos con el famoso Javadoc, una herramienta que permite la documentación de nuestro código.

package ejemplos;

/**
* <h1>Main.java</h1>
* @author Codemonkey Junior
* @version 1.0.0
* @see http://codemonkeyjunior.blogspot.com
* 
*/

import static java.lang.System.out;

public class Main{
  /**
  *
  *@param args
  * 
  */
  public static void main(String[] args){
     out.println("Hola, mundo en Java");
  }
}

En este ejemplo podemos ver el uso de etiquetas especiales que nos ayudan describir partes del código que pudieran ser importantes. Como dice una regla no escrita en el mundo de la programación:

Pasamos más tiempo viendo el código de otros, que escribiendo nuevo código

Y que mejor si este código está documentado. En Erlang también existen etiquetas similares al Javadoc de Java. En este ejemplo podemos ver el uso de estás etiquetas.

%%% @doc Programa para conversion de temperaturas
%%% @copyright Inforhomex 2021
-module(conversion).
-author("Codemonkey Junior").
-version("1.0.0").
-export([fahr/1, cels/1]).

%% @doc De Celsius a Fahrenheit
-spec fahr(number()) -> number().
fahr(C) -> (C-32)/1.8.


%% @doc De Fahrenheit a Celsius
-spec cels(number()) -> number().
cels(F) -> (F*1.8)+32.

%% @end

%% erl
%% > c(conversion).
%% > conversion:fahr(-32.8).
%% > conversion:cels(22.9).

Hay un post en Stackoverflow que podría ser muy útil para saber más sobre la documentación de código en Erlang: https://stackoverflow.com/questions/9378765/specifications-for-functions-spec-efficiently-usage En próximos post hablaremos más de este lenguaje.

Enlaces:
http://codemonkeyjunior.blogspot.com/2021/05/erlang-en-ejemplos.html
https://codemonkeyjunior.blogspot.com/2021/05/erlang-modulos.html
https://zxq9.com/projects/zomp/
https://zxq9.com/archives/1650 https://learnyousomeerlang.com/