问题标签 [haddock]

我正在编写一个 Cabal-install 替代品来编译我自己的项目（如果你好奇的话，可以在 Github 上查看），并且几乎已经让它完全可操作，但有一个细节：当为单独的包生成文档时，Haddock 没有' 似乎无法找到其他包的 HTML 目标，即使它确实读取了由所述其他包生成的接口文件。

这是我的构建系统对 Haddock 的调用，及其伴随的输出：

我还尝试了几乎所有可能的方法来编写--read-interface标志，包括：

• 作为构建目录的相对路径
• 作为file://网址
• 带有 0、1 和 2 前缀，应该指示 HTML 链接目录

我知道接口文件被正确读取，因为当文件不存在时 Haddock 会失败，并且我知道 HTML 文件在正确的位置，因为我现在正在浏览它们，所以我找不到为什么 Haddock 没有的解释见不到他们。

这种情况困扰了我将近两个月，我已经学会接受在我的文档中没有超链接的生活的灰色，但如果有人知道该怎么做，我将永远感激:-)

谢谢你的时间，

是否可以使用 Haddock 记录类方法并在实例声明代码中查询文档片段？

例如，我希望像这样记录的类：

和这样记录的实例：

并让 html Haddock 文档看起来像这样（对不起，我没有图像）：

当在实例中添加模式同时将整个方法文档保存在一个独立的段落中时，这种文档组织将更具可读性和可扩展性。可能吗？

我正在使用 Haddock 2.10.0 版。在 Debian 7.0 上。

谢谢您的帮助。

我想在我的源代码中对方程式使用乳胶表示法。例如，我会在一些 haskell 源文件 Equations.hs 中写下以下注释：

在doc目录中，这由 Equations.tex 中的黑线鳕呈现为：

我在 Haddock 的乳胶后端的源代码中找到了这个函数，它替换了乳胶格式中使用的许多字符：

是否有任何现有功能可以让我绕过这个并在评论中插入乳胶方程？

我有许多 haskell 包，并且我启用了一些标志以允许它们生成黑线鳕文档。现在这些文件位于/usr/share/doc/{package-name}-{version}/html/.

有组织它们的工具吗？我想要在hackage中按名称页面列出所有包的东西，以便可以在一页中找到所有这些已安装包的本地链接。

如果能告诉hoogle使用这些文件就更好了。到目前为止，我的 hoogle 搜索结果都指向 hackage 中的相应页面。

我有一个带有长元组的 Haskell 函数签名，我正在尝试为 Haddock 注释：

如果我将元组成员上的注释转换为 Haddock 标记（-- ^与前面的参数类型一样），Haddock 会因解析错误而退出。我发现一些评论表明这只是一个限制，没有什么可做的；是这样吗？这很糟糕；文档和概要栏都超出了屏幕边缘并且不可读。我真的不想为了满足 Haddock 的需要而引入一个单独的类型来代替元组。

谢谢！

（更新：有一个开放的 Haddock功能请求，似乎确认当前不支持此功能；我已在其中添加了我的 +1 ——但如果有人有补丁或解决方法，我很感兴趣。）

My Haskell file (pretty sure this is not the problem) is basically:

My Setup.hs:

My grade.cabal:

When I run cabal haddock --executables I get

and the HTML contains main but no documentation for it. It does not even contain functions I defined other than main. Why is that?

假设有一个所有可能事物的列表

现在我们有另一个函数，它接受一个整数N和两个策略，并使用第一个策略进行N次数，然后使用第二个策略进行N次数，并根据需要继续重复。
如果N是 0 会发生什么，我想返回一个随机策略，因为它破坏了函数的目的，但它必须最终应用特定策略。

所以我试图从列表中获得一个随机策略。我认为这会做到：

但是如何使用 Haddock/doctest 对其进行测试？

我认为随机函数有点违背 Haskell 的函数思想，但我也可能错了。在命令式语言中，随机函数使用各种参数（如 Java 中的时间）来确定随机数，所以我不能只插入一个/特定参数来确保我会得到哪个随机数吗？

我想知道停止和启动 cloudera CDH5.2 集群的命令行。

原因，我正在编写一个用于运行一些基准测试的自动化脚本，并希望在开始每个基准测试之前停止和启动集群。

我已经看到停止 CDH 集群并不完全等同于：-

服务 cloudera-scm-server 停止

服务 cloudera-scm-server-db 停止

服务 cloudera-scm-agent 停止

典型的Haddock语法允许写这样的东西

我想用Java方式编写它，在函数签名之前我有参数描述。我有更复杂的签名，所以这种方法破坏了可读性。有没有这样写的方法？

我尝试使用cabal haddock. 我的项目结构如下所示：

当我运行cabal haddock --executable它失败并显示以下错误消息：

该Source.hs文件具有以下内容：

ghc版本是，7.8.3黑线鳕版本是2.14.3。