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