Ординарные кавычки часто используются в английском языке как апострофы, в таких сочетаниях как
don’t, isn’t. Перед такими вхождениями ординарных кавычек можно не писать обратный слэш. Haddock сумеет
отличить их от идентификатора.
Курсив и моноширинный шрифт
Для выделения текста курсивом, он заключается в окружение ... . Для написания текста моноширинным
шрифтом, он заключается в окружение ...@@.
Модули
Для обозначения модулей используются двойные кавычки, как в
-- | This is a reference to the ”Foo” module.
Создание документации с помощью Haddock | 273
Списки
Список без нумерации обозначается с помощью звёздочек:
-- | This is a bulleted list:
--
--
* first item
--
--
* second item
Пронумерованный список, обозначается символами (n) или n. (n с точкой), где n – некоторое целое
число:
-- | This is an enumerated list:
--
--
(1) first item
--
--
2. second item
Список определений
Определения обозначаются квадратными скобками, например комментарий:
-- | This is a definition list:
--
--
[@foo@] The description of @foo@.
--
--
[@bar@] The description of @bar@.
в документации будет выглядеть так:
foo The description of foo.
bar The description of bar.
Для выделения текста моноширинным шрифтом мы воспользовались окружением ...@@.
URL
Ссылки на сайты включаются с помощью окружения <...> .
Ссылки внутри модуля
Для того чтобы сослаться на какой-нибудь текст внутри модуля, его необходимо отметить ссылкой. Для
этого мы помещаем в том месте, на которое мы хотим сослаться, запись #label#, где label – это идентифика-
тор ссылки. Теперь мы можем сослаться на это место из другого модуля с помощью записи ” module#label”,
где module – имя модуля, в котором находится ссылка label.
18.3 Краткое содержание