haskell - haskell 应用程序项目文档

Question

什么是识字编程？引用 Knuth 博士的话：“主要思想是将程序视为与人类的交流，而不是对计算机的一组指令。”

生成haskell应用程序项目文档的流行方法是什么？请提及每种方法的主要优势领域/主要优势。

Answer 1

最常见的方法是使用Haddock 标记。

为此，您可以使用 . 开头的注释行-- |。文档一直持续到下一个非注释行：

-- |This is a doc comment
--  which continues onto the next line.

如果要生成指向文档其他部分的链接，请在函数名称周围使用单引号。如果要指定固定宽度的字体，请将文本括在@符号中。如果要指定代码块，请以 . 开头的注释行-- >。

这是一个从GHC Base 源代码中提取的真实示例，该示例编译到此页面上的文档中。

-- | 'map' @f xs@ is the list obtained by applying @f@ to each element
-- of @xs@, i.e.,
--
-- > map f [x1, x2, ..., xn] == [f x1, f x2, ..., f xn]
-- > map f [x1, x2, ...] == [f x1, f x2, ...]

map :: (a -> b) -> [a] -> [b]
map _ []     = []
map f (x:xs) = f x : map f xs