有没有办法使Haddock呈现类型参数方法的每个参数的文档?

马克·卡波夫

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

class Foo a where

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

这给我维护的库的用户带来了某些问题,因为在我的情况下,这些方法的签名很长。我一直在源代码中使用这种格式的描述(一定适用于普通函数),但事实证明,Haddock不会显示它们(也不会抱怨它们)。

有没有办法用Haddock显示每个参数的文档?可能有一些解决方法?

马克·卡波夫

好的,这是回归。这个东西应该可以工作(并在2.16.1版本中可以工作),但是可以停止工作(2.17.1和更高版本)。

我已经报告了这个问题:https : //github.com/haskell/haddock/issues/647,应该在2.18版本中修复(您可以看到已经有PR了)。

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章

有没有办法减少多个类型的参数?

有没有办法从非静态方法获取参数类型?

有没有办法记录功能参数的参数?

有没有办法在TypeScript函数文档中引用参数?

有没有办法接受类型为以下列方式在Java中的静态方法的参数?

有没有办法使函数成为参数?

define:有没有办法扩展参数?

有没有办法让Typescript使用默认参数?

有没有办法让RoutePrefix以可选参数开头?

有没有办法告诉 GCC 参数的范围?

有没有办法在解构后获得参数?

有没有办法创建动态参数?

有没有办法让 TypeScript 根据调用参数推断函数返回值的类型?

有没有办法接受Kotlin中类型A或B的参数?

有没有办法在Java中的列表中提取列表的类型参数?

有没有办法描述/类型提示功能参数的内容?

有没有办法为参数指定各种类型

有没有办法找到Java中模板(通用)参数的类型?

有没有办法用宏来捕获函数定义的参数类型?

打字稿有没有办法推断依赖于输入参数的类型?

有没有办法根据模板参数的类型在不同的类实现之间进行选择?

有没有办法在参数中转换解构道具的类型?

有没有办法对相同类型的参数进行分组以使代码整洁?

有没有办法在 Python 中参数化自定义类型?

有没有办法调用具有非pythonic参数的cdef类方法?

有没有办法打印在__init__方法中创建的对象的所有参数?

有没有办法将方法作为参数传递给方法?

有没有办法可以在 Visual Studio IDE 中显示方法的注释参数?

有没有办法在可调用方法中接受参数?