раздела. В нём мы можем пояснить по какому принципу группируются определения в данном разделе.
Разметка
С помощью специальных символов можно выделять различные элементы текста, например, ссылки, куски
кода, названия определений или модулей. Haddock установит необходимые ссылки и выделит элемент в
документации.
При этом символы \, ’, ‘, ”, @, < являются специальными, если вы хотите воспользоваться одним из
специальных символов в тексте необходимо написать перед ним обратный слэш \. Также символы для обо-
значения комментариев *, |, ^ и > являются специальными, если они расположены в самом начале строки.
272 | Глава 18: Средства разработки
Параграфы
Параграфы определяются по пустой сроке в комментарии. Так например мы можем разбить текст на два
параграфа:
-- | The first paragraph goes here.
--
-- The second paragraph goes here.
fun :: a -> b
Блоки кода
Существует два способа обозначения блоков кода:
-- | This documentation includes two blocks of code:
--
-- @
--
f x = x + x
--
g x = x
-- @
--
-- >
g x = x * 42
В первом варианте мы заключаем блок кода в окружение ...@@. Так мы можем выделить целый кусок
кода. Для выделения одной строки мы можем воспользоваться знаком > .
Примеры вычисления в интерпретаторе
В Haddock мы можем привести пример вычисления выражения в интерпретаторе. Это делается с помощью
тройного символа > :
-- | Two examples are given bellow:
--
-- >>> 2+3
-- 5
--
-- >>> print 1 >> print 2
-- 1
-- 2
Строки, которые идут сразу за строкой с символом >>> помечаются как результат выполнения выражения
в интерпретаторе.
Имена определений
Для того чтобы выделить имя любого определения, будь то функция, тип или класс, необходимо заклю-
чить его в ординарные кавычки, как в ’T’. При этом Haddock установит ссылку к определению и подсветит
имя в тексте. Для того чтобы сослаться на определение из другого модуля необходимо написать его полное
имя, то есть с приставкой имени модуля, например функция fun, определённая в модуле M, имеет полное