如何用黑线鳕生成文档？

Question

我正在使用的项目在 Stackage 上没有文档（它们已过时）。这是原始版本 0.3

有人告诉我可以用黑线鳕生成文档。我的电脑上有源代码（使用 git clone）版本 0.4

haddock 网页太高级了。

对于初学者来说，进入我的目录后，如何生成文档？

感谢其中一个答案，我取得了进步，但这是一条错误消息：

src/Reflex/Dom/Xhr.hs:154:0:
     error: missing binary operator before token "("
     #if MIN_VERSION_aeson(1,0,0)
     ^

Answer 1

cabal haddock 或 stack haddock.

Answer 2

安装 haddock 后，您可以运行如下所示：

haddock --html -o <haddock-folder> <list-of-haskell-files>

例如：

haddock --html -o the_documentation *.hs

将在名为 the_documentation.

的目录中生成该目录（不是任何子目录）中所有 Haskell 文件的文档

一些 shell 允许 **.hs 查找所有 .hs 文件（包括子目录）。所以你可以试试：

haddock --html -o the_documentation **.hs

如果 shell 不支持，你当然可以使用 find 和 xargs 的组合，例如：

find -iname '*.hs' | xargs haddock --html -o the_documentation

这里find会生成所有以.hs结尾的文件的列表，xargs会将这些文件全部作为参数写入haddock --html ....

how to generate documentations with haddock?