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