haskell - 黑线鳕对进口实体的评论

Question

有没有办法将黑线鳕文档添加到导出它的模块中的实体，而不是声明它的实体？

我有一个隐藏模块，它声明了十几种类型，然后是另一个模块，它只导出最终用户应该看到的部分。将文档放在公开模块而不是隐藏模块中是合乎逻辑的。但我不知道该怎么做......

Answer 1

不，这不可能。函数可以有每个参数和每个类型参数的文档，如果可以的话，它会使文档不一致:

1. 在不同的地方写不同的版本
2. 让一个版本覆盖另一个
3. 在参数文档中引入不一致:如果您覆盖函数的主文档字符串会怎样；应该删除参数文档字符串吗？

以下文件:

module Bla
       ( -- * Fooishness

         -- | This is 'foo'. It is not 'bar'.
         foo
       , -- * Barishness

         -- | This is 'bar'. It is sometimes a little 'foo'.
         bar
       ) where

-- | The actual foo documentation
foo :: a -- ^ The a
    -> b -- ^ The b
    -> c
foo = undefined

-- | The actual bar documentation
bar :: a
bar = undefined

...生成此文档:

如您所见，您可以使用部分注释来模拟函数文档字符串，但只有在您使用类型签名正确的函数文档注释时才能正确生成文档。