= A
-- | constructor B
| B
-- | constructor C
| C
Или так:
Создание документации с помощью Haddock | 271
data T = A
-- ^ constructor A
| B
-- ^ constructor B
| C
-- ^ and so on
Комментарии к классу:
-- | С-class
class С a where
-- | f-function
f :: a -> a
-- | g-function
g :: a -> a
Комментарии к модулю
Комментарии к модулю помещаются перед объявлением имени модуля. Эта информация попадёт в самое
начало страницы документации:
-- | Little example
module Hello where
Структура страницы документации
Если модуль большой, то его бывает удобно разделить на части, словно разделы в главе книги. Определе-
ния группируются по функциональности и помещаются в разные разделы или даже подразделы. Структура
документации определяется с помощью специальных комментариев в экспорте модуля. Посмотрим на при-
мер:
-- | Little example
module Hello(
-- * Introduction
-- | Here is the little example to show you
-- how to make docs with Haddock
-- * Types
-- | The types.
T(.. ),
-- * Classes
-- | The classes.
C(.. ),
-- * Functions
helloWorld
-- ** Subfunctions1
-- ** Subfunctions2
) where
...
Комментарии со звёздочкой создают раздел, а с двумя звёздочками – подраздел. Те определения, ко-
торые экспортируются за комментариями со звёздочкой попадут в один раздел или подраздел. Если сразу