stringtranslate.com

Abadejo (software)

Haddock es un generador de documentación de programas de línea de comandos gratuito y portátil [2] para Haskell .

Software

Está influenciado por IDoc , [3] HDoc, [4] y Doxygen . [5] Produce archivos HTML con hipervínculos a partir de archivos fuente anotados de Haskell (la documentación está incrustada en comentarios ) , con información adicional extraída de anotaciones de tipo ; solo admite la generación parcial de documentación en SGML . [6] A menudo se usa junto con darcs y Cabal . Depende de Glasgow Haskell Compiler (GHC), y usa una forma modificada del analizador HsParser (escrito en Happy ) para Haskell incluido en GHC. [6] Su marcado liviano se basa en IDoc. [6] Haddock está contenido en Haskell Platform .

Lo utilizan los proyectos GHC, Gtk2Hs y HTk, [7] así como xmonad . [ cita requerida ]

A continuación se muestra un ejemplo del marcado de Haddock:

 -- | Esta es la documentación de 'cuadrado', que -- utiliza el operador (*) de "Preludio". -- Multiplica el argumento @x@ por sí mismo. cuadrado :: Entero -> Entero cuadrado x = x * x

Referencias

  1. ^ "Versión 2.25.0". 2 de marzo de 2021. Consultado el 25 de marzo de 2021 .
  2. ^ Haddock se ejecuta en sistemas operativos compatibles con POSIX y Microsoft Windows .
  3. ^ "Manual de IDoc - Instalación". www.cse.unsw.edu.au .
  4. ^ "Página web de Armin Größlinger". www.fmi.uni-passau.de .
  5. ^ "1.3. Colaboradores". haskell.org .
  6. ^ abc "Haddock: una herramienta de documentación de Haskell" Archivado el 11 de octubre de 2006 en Wayback Machine -(por Simon Marlow, Actas del taller ACM SIGPLAN sobre Haskell , 2002; PDF )
  7. ^ "Haddock se está utilizando para documentar las nuevas bibliotecas jerárquicas de Haskell. La documentación generada para las bibliotecas incluidas con la última versión de GHC se encuentra aquí. El proyecto Gtk2Hs está utilizando Haddock para generar documentación de referencia. El proyecto HTk está utilizando Haddock para generar la documentación de su biblioteca". Desde la página de inicio de Haddock.

Enlaces externos