miércoles, 31 de agosto de 2016

Haskell - Haddock

Haddock es una herramienta de generación de documentación de alta calidad para lenguaje Haskell. Utiliza comentarios y tipos del código para generar documentación on-line indexada y con referencias cruzadas.
Pagina de la herramienta: Haddock Site
Manual del usuario         : Haddock On-line

Ejemplo de Uso
En el directorio donde se encuentra el modulo con el practico del lenguaje Haskell:
1) Generar el directorio DOC 
2) Bajar en su computadora personal, en el directorio que contiene el práctico, el siguiente archivo:
    PracHaskell2016.txt

3) Ejecutar la siguiente sentencia en la línea de comando del sistema operativo (Inicio/cmd en Windows, abrir terminal en Linux y OS X):

haddock PracHaskell2016.hs -o ".\Doc" -h -t "Practico Haskell 2016" -p PracHaskell2016.txt

Explicacion del comando (ver capítulo 2 del manual del usuario):

haddock PracHaskell2016.hs   -- se invoca haddock con el archivo PracHaskell2016.hs
-o ".\Doc"                   -- se configura directorio de salida (en Linux o OSX "./Doc)
-h                                    -- generar documentación en formato HTML
-t "Laboratorio Haskell 2016" -- usar este título en encabezamiento de c/pagina
-p LabHaskell.txt            --prologo que se colocará en la pagina principal en 

                                         Descripción

abrir el archivo index.html generado por Haddock en el directorio Doc para ver la documentación generada.

No hay comentarios.:

Publicar un comentario