Question

什么是文学编程？引用Knuth博士的话： “主要的想法是将程序视为与人类的沟通，而不是作为计算机的一套指令。”

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

Answer 1

最常见的方法是使用Haddock markup。

要执行此操作，请使用-- |开始注释行。文档将继续，直到下一个非注释行：

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

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

以下是从GHC Base source code中获取的真实示例，该示例汇编为this page上显示的文档。

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

haskell应用程序项目文档

1 个答案: