事实证明,Haddock不为类型类方法呈现每个参数的文档:
class Foo a where
foo
:: Int -- ^ This string will be ignored by Haddock
-> a
Run Code Online (Sandbox Code Playgroud)
这会给我维护的库的用户带来某些问题,因为我的方法中的方法有很长的签名.我总是把源代码格式化的描述(当然适用于普通函数),但事实证明Haddock不会显示它们(也不会抱怨它们).
有没有办法用Haddock显示每个参数的文档?也许有些解决方法?
好吧,这是一种回归。这个东西应该可以工作(并且在版本 2.16.1 中工作),但是停止了(2.17.1 及更高版本)。
我已经报告了这一点: https: //github.com/haskell/haddock/issues/647,应该在版本 2.18 中修复(你可以看到已经有一个 PR)。