问题标签 [haddock]

我正在尝试记录我的来源，但我遇到了命名块的问题。

我想记录大量模式（超过 50 个），我想将每个解释保留在代码附近，并将所有解释收集在标题中

我尝试了以下方法：

但只显示第一个块：

我的 Haddock 标记有问题还是错误？

我在运行 OS X 10.11.1 的 MacBook Pro 上安装了Haskell Platform 7.10.2-a1 64bit- signed.pkg。

它在 Safari 中带来了不错的显示效果。当我单击“库”和“Codec.Compression.Zlib”时，我得到一个 Safari can't find the file带有 url的页面file:///Library/Haskell/ghc-7.10.2-x86_64/lib/zlib-0.5.4.2/doc/html/Codec-Compression-Zlib.html

我搜索了“ghc-pkg”的输出，发现还有很多缺失，包括vector, syb, split, parsec, parallel, QuickCheck-- 总共 42 个。

我做错什么了？谢谢！

在 Haddock 中，“内联代码”¹标记 ,@...@与“代码块”标记相同，

如何编写仅包含内联代码跨度的单行 Haddock 注释，而不会被误解为块？像这样的评论

呈现为块

而不是所需的内联

code span

如果有更多示例有帮助，上下文是我正在编写表示 BNF 语法的数据类型，因此我有许多类型，如下所示：

这个例子对应的语法

因此语法嵌入在 Haddock 注释中。但是由于 Haddock 将这些@...@注释解析为块，输出不必要地高，并且当某些行有额外的注释文本（例如，-- ^@double /term/@ – syntax sugar）时不一致。

¹ 又名“等宽”或“打字机”。

I'd like to host my haddock docs on my own site, but when I generate them on my machine they contain file:// links to the values and types from base:

Is there a way to tell haddock to use a different base url for links to identifiers from outside my package?

我正在编写一个库，并在其中定义并导出了一些（非常复杂的）类型 synonym T。

在库内部，类型是有意义的。然而，对于用户来说，这是不必要的和令人困惑的。出于这个原因，我更愿意在 Haddock 页面中隐藏类型的实际声明。

IE，我希望黑线鳕页面看起来像这样......

......而不是这个。

这可能吗？如果是这样，怎么做？

如果我将整个块放在 CPP 条件分支中，我可以根据标志更改黑线鳕：

并且文档看起来像您期望的那样，并且doctest也可以按预期工作。

但对于较大的注释或代码块来说，这是维护的噩梦。另一方面，这似乎不起作用：

这是为什么？CPP不是在黑线鳕之前处理吗？我的直觉是因为换行符在 CPP 阶段之后仍然存在，但这只是一种直觉

我正在生成我的黑线鳕：

stack haddock --no-haddock-deps

我从帮助中对此选项的理解：

Enable/disable building Haddocks for dependencies

将是它不会为任何依赖项生成黑线鳕。但这种情况并非如此。它生成两个 html 文件：

Updating Haddock index for local packages in /myDir/.stack-work/install/x86_64-osx/lts-6.16/7.10.3/doc/index.html Updating Haddock index for local packages and dependencies in /myDir/.stack-work/install/x86_64-osx/lts-6.16/7.10.3/doc/all/index.html

我不想要依赖项的文档。只有我的模块。我怎样才能做到这一点？

我的问题很简单，如何安装黑线鳕？

我在 Windows 中使用 GHCi 版本 8.0.1。黑线鳕与 Windows GHCI 兼容吗？

例如，我如何在 hackage 上查看 Data.List.group 的文档？

如果我尝试将 Haddock 用作：

另一方面，我知道这些 html 文档存在于我的计算机/usr/local/share/doc目录下。

还是我弄错了，这不是黑线鳕所做的？

stack haddock（或stack build --haddock）将它生成的文档放在哪里？