问有没有办法让Haddock为类型类方法呈现每个参数的文档？
EN

Stack Overflow用户

提问于 2017-06-29 17:13:58

回答 1查看 101关注 0票数 8

事实证明，Haddock不会为类型类方法呈现每个参数的文档：

class Foo a where

  foo
    :: Int -- ^ This string will be ignored by Haddock
    -> a

这给我维护的一个库的用户带来了某些问题，因为我的例子中的方法有相当长的签名。我在源代码中的描述总是这样格式化的(当然适用于普通函数)，但事实证明Haddock不会显示它们(也不会抱怨它们)。

有没有办法用Haddock显示每个参数的文档？也许是一些变通的方法？

回答已采纳

发布于 2017-06-30 01:34:09

好吧，这是一种回归。这个东西应该可以工作(在2.16.1版本中也可以工作)，但是停止了(2.17.1及更高版本)。

我已经报告了这一点：https://github.com/haskell/haddock/issues/647，应该在2.18版本中得到修复(你可以看到已经有了PR )。

票数 3

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/44820920

复制

相似问题

问有没有办法让Haddock为类型类方法呈现每个参数的文档？EN