Пикша (программное обеспечение) - Википедия - Haddock (software)

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

Пикша это свободный, портативный[1] командная строка программная документация генератор за Haskell. На него влияет IDoc,[2] HDoc,[3] и Doxygen.[4] Он производит гиперссылка HTML файлы из аннотированного Haskell (документация встроена в Комментарии ) исходные файлы, с дополнительной информацией, извлеченной из аннотации типов; он поддерживает только частичное создание документации в SGML.[5] Часто используется вместе с даркс и Кабала. Это зависит от Компилятор Glasgow Haskell (GHC), используя модифицированную форму HsParser (написанную на Счастливый ) парсер для Haskell, включенного в GHC.[5] Его легкая разметка основана на IDoc.[5] Пикша содержится в Платформа Haskell.

Используется проектами GHC, Gtk2Hs и HTk,[6] а также XMonad.[нужна цитата ]

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

 - | Это документация для "квадрата", который - использует оператор (*) из "Prelude". - Он умножает аргумент @ x @ против самого себя. квадрат :: Целое число -> Целое число квадрат Икс = Икс*Икс

Рекомендации

  1. ^ Пикша бежит по POSIX -совместимые операционные системы и Майкрософт Виндоус.
  2. ^ «Руководство IDoc - Установка». www.cse.unsw.edu.au.
  3. ^ "Домашняя страница Армина Грёсслингера". www.fmi.uni-passau.de.
  4. ^ «1.3. Авторы». haskell.org.
  5. ^ а б c "Пикша: инструмент документации Haskell" В архиве 2006-10-11 на Wayback Machine - (Саймон Марлоу, Труды семинара ACM SIGPLAN на Haskell, 2002; PDF )
  6. ^ "Пикша используется для документирования новых иерархических библиотек Haskell. Документация, созданная для библиотек, поставляемых с последней версией GHC, находится здесь. Проект Gtk2Hs использует Haddock для создания справочной документации. Проект HTk использует Haddock для создания своей библиотеки документация." Из пикши домашняя страница.

внешняя ссылка