Хэддок (программное обеспечение)

Пикша
Разработчик(и)	Саймон Марлоу
Первоначальный выпуск	1 мая 2002 г.
Стабильная версия	2.25.0 / 2 марта 2021 г .; 3 года назад
Репозиторий	github .с /хаскелл / пикша ;
Написано в	Хаскелл
Операционная система	Кросс-платформенный
Платформа	x86 , PowerPC
Тип	Генерация документации
Лицензия	Лицензия в стиле BSD
Веб-сайт	http://haskell.org/haddock/

Haddock — бесплатная портативная программа. ^[2] командной строки программной документации Генератор для Haskell .

Программное обеспечение

На это влияет IDoc , ^[3] ХДок , ^[4] и Доксиген . ^[5] Он создает файлы с гиперссылками HTML- Haskell (документация встроена в комментарии ) из аннотированных исходных файлов с дополнительной информацией, извлеченной из аннотаций типов ; он поддерживает лишь частичное создание документации в SGML . ^[6] Он часто используется в сочетании с дарками и Кабалом . Он зависит от компилятора Glasgow Haskell Compiler (GHC), использующего модифицированную форму HsParser (написанного на Happy ) парсера для Haskell, включенного в GHC. ^[6] Его облегченная разметка основана на IDoc. ^[6] Haddock содержится в платформе Haskell .

Он используется проектами GHC, Gtk2Hs и HTk. ^[7] а также xmonad . ^{[ нужна ссылка ]}

Вот пример разметки Haddock:

 -- | This is the documentation for 'square', which
 --   uses the (*) operator from "Prelude".
 --   It multiplies the @x@ argument against itself.
 square :: Integer -> Integer
 square x = x*x

Ссылки

^ «Выпуск 2.25.0» . 2 марта 2021 г. Проверено 25 марта 2021 г.
^ Haddock работает в POSIX -совместимых операционных системах и Microsoft Windows .
^ «Руководство по IDoc – Установка» . www.cse.unsw.edu.au.
^ «Домашняя страница Армина Грёслингера» . www.fmi.uni-passau.de .
^ «1.3. Авторы» . Haskell.org .
^ Jump up to: ^а ^б ^с «Haddock: Инструмент документации Haskell». Архивировано 11 октября 2006 г. в Wayback Machine - (Саймон Марлоу, Материалы семинара ACM SIGPLAN по Haskell , 2002; PDF )
^ «Haddock используется для документирования новых иерархических библиотек Haskell. Документация, созданная для библиотек, поставляемых с последней версией GHC, находится здесь. Проект Gtk2Hs использует Haddock для создания справочной документации. Проект HTk использует Haddock для создания своей библиотечная документация». Хэддока С домашней страницы .

Внешние ссылки

Официальный сайт

[wikidata-de217db692e2e9258ab483c6d487b4b4cc3b894a-v13-1] «Выпуск 2.25.0» . 2 марта 2021 г. Проверено 25 марта 2021 г.

[2] Haddock работает в POSIX -совместимых операционных системах и Microsoft Windows .

[3] «Руководство по IDoc – Установка» . www.cse.unsw.edu.au.

[4] «Домашняя страница Армина Грёслингера» . www.fmi.uni-passau.de .

[influences-5] «1.3. Авторы» . Haskell.org .

[research-6] Jump up to: ^а ^б ^с «Haddock: Инструмент документации Haskell». Архивировано 11 октября 2006 г. в Wayback Machine - (Саймон Марлоу, Материалы семинара ACM SIGPLAN по Haskell , 2002; PDF )

[7] «Haddock используется для документирования новых иерархических библиотек Haskell. Документация, созданная для библиотек, поставляемых с последней версией GHC, находится здесь. Проект Gtk2Hs использует Haddock для создания справочной документации. Проект HTk использует Haddock для создания своей библиотечная документация». Хэддока С домашней страницы .

[1]

[2]

[3]

[4]

[5]

[6]

[7]