3

基础黑线鳕中有一些模块没有文档链接。例如,GHC/Show.hs有黑线鳕注释,但GHC.Show在 Hackage 上没有该模块的文档。为什么不?这是一个错误吗?

4

1 回答 1

2

这显然是故意的。这是GHC/Show.hs中这一行的结果:

{-# OPTIONS_HADDOCK hide #-}

黑线鳕文档的相关摘录:

可以为每个模块指定某些属性,这会影响 Haddock 为该模块生成文档的方式。属性在{-# OPTIONS_HADDOCK ... #-}模块顶部的 pragma 中以逗号分隔的列表中指定,在模块描述之前或之后。

[...]

Haddock目前可以理解以下属性:

  • 隐藏

    从生成的文档中省略此模块,但仍将定义和文档从该模块内传播到重新导出这些定义的模块。

[...]

于 2017-06-07T14:33:33.820 回答