Haskell应用程序项目文档

Question

什么是识字编程？引用高德纳博士的话： "主要思想是将程序视为与人类的通信，而不是与计算机的一组指令。

生成Haskell应用程序项目文档的流行方法有哪些？请提及每种方法的主要强度区域/主要优点。

Answer 1

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

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

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

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

下面是取自 GHC 基本源代码的真实示例，该源代码编译到本页上看到的文档。

-- | '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