Haddock (software) - Haddock (software) - Wikipedia
 | tento článek příliš spoléhá na Reference na primární zdroje. (Září 2018) (Zjistěte, jak a kdy odstranit tuto zprávu šablony) |
| Vývojáři | Simon Marlow |
|---|---|
| První vydání | 1. května 2002 |
| Stabilní uvolnění | 2.8.0 / 2. září 2010 |
| Úložiště |  |
| Napsáno | Haskell |
| Operační systém | Cross-platform |
| Plošina | x86, PowerPC |
| Typ | Generování dokumentace |
| Licence | Licence ve stylu BSD |
| webová stránka | http://haskell.org/haddock/ |
Treska jednoskvrnná je volný, uvolnit přenosný[1] příkazový řádek programová dokumentace generátor pro Haskell. Je to ovlivněno IDoc,[2] HDoc,[3] a Doxygen.[4] Produkuje hypertextový odkaz HTML soubory z anotovaného Haskella (dokumentace je vložena do komentáře ) zdrojové soubory, s dalšími informacemi extrahovanými z zadejte poznámky; podporuje pouze částečně generování dokumentace v Linuxu SGML.[5] Často se používá ve spojení s Darcs a Cabal. Závisí to na Překladač Glasgow Haskell (GHC), s použitím upravené formy HsParser (napsané v Šťastný ) analyzátor pro Haskell obsažený v GHC.[5] Jeho lehká značka je založena na IDoc.[5] Treska jednoskvrnná je obsažena v Haskell Platform.
Používají jej projekty GHC, Gtk2Hs a HTk,[6] stejně jako XMonad.[Citace je zapotřebí ]
Zde je příklad značky Haddock:
- | Toto je dokumentace pro „square“, která - používá operátor (*) z „Prelude“. - Násobí argument @ x @ proti sobě. náměstí :: Celé číslo -> Celé číslo náměstí X = X*XReference
- ^ Haddock běží dál POSIX - kompatibilní operační systémy a Microsoft Windows.
- ^ "Manuál IDoc - instalace". www.cse.unsw.edu.au.
- ^ „Domovská stránka Armina Größlingera“. www.fmi.uni-passau.de.
- ^ „1.3. Přispěvatelé“. haskell.org.
- ^ A b C „Haddock: A Haskell Documentation Tool“ Archivováno 2006-10-11 na Wayback Machine - (Simon Marlow, Sborník workshopů ACM SIGPLAN na Haskellu, 2002; PDF )
- ^ „Haddock se používá k dokumentaci nových hierarchických knihoven Haskell. Dokumentace vygenerovaná pro knihovny dodávané s nejnovější verzí GHC je zde. Projekt Gtk2Hs používá Haddock k vytvoření referenční dokumentace. Projekt HTk používá Haddock ke generování své knihovny dokumentace." Z tresky jednoskvrnné domovská stránka.
externí odkazy
 | Tento programovací nástroj související článek je a pahýl. Wikipedii můžete pomoci pomocí rozšiřovat to. |