El Bruno

Buenas,

estaba terminando de repasar y actualizar algunas demos de F#, cuando caí en la realidad de que no sabía como eran las opciones de generacion de documentacion que posee F#. Ya que F# permiten generara bibliotecas .Net, que van a ser utilizadas en otros lenguajes, lo ideal es que las mismas posean documentacion propia para ayudar a nuestros queridos amigos los developers. Asi que después de investigar un rato, me di cuenta de que el generador de documentación utiliza la misma sintaxis que C#, con lo que más simple imposible.

El siguiente tutorial muestra como crear un proyecto en F#, generar documentacion en el mismo y consumirlo desde un cliente C#.

Tutorial

1. Crear un nuevo proyecto en Visual Studio 2010 del tipo F# Library. Para este ejemplo le pondremos de nombre FSharpDoc.

2. Modificar el archivo module1.fs con el siguiente código

   1: module FuncionesDelBruno

   2:  

   3: /// <summary>

   4: /// Suma dos numeros

   5: /// </summary>

   6: /// <param name="a">primer argumento</param>

   7: /// <param name="b">segundo argumento</param>

   8: /// <returns>la suma de los 2 parámetros</returns>

   9: let Sumar a b = a + b

  10:  

3. Activar la generacion de documentacion, en las propiedades del proyecto en la seccion Build, marcando el check que muestra la siguiente imagen.

4. Compilar el proyecto.

5. Agregar un nuevo proyecto de consola en C# a la solucion, llamado ConsoleApplication1.

6. En el nuevo proyecto, agregar una referencia al proyecto FSharpDoc.

7. Cuando en el editor de código de C#, comenzamos a utilizar el módulo creado en los pasos anteriores, podremos ver como para la función Sumar(a,b) el intellisense muestra la información definida en la documentacion del mismo.

8. Done !!! más simple imposible, aunque no hay generador de documentación automática por ahora en F#.

Saludos @ La Finca

El Bruno