首页 > 解决方案 > 如何使用 Haddock 记录类型类约束?

问题描述

我试图记录一些非常可怕的类型类约束并解释为什么需要它们,但我似乎无法在 Haddock 中得到以下工作:

{-|

This will show-up at the top of the module

-}

module Try where

-- | This shows up immediately after the class "header"
class (

    -- | PROBLEM: This doesn't work...
    Show a -- ^ PROBLEM: Also, this doesn't work

    ) => Something a where

    -- | This shows up as the method's documentation
    something :: a -> Int

标签: haskellhaddock

解决方案


没有任何方法可以使用最新版本的 Haddock。

这个想法之前已经提出过:https ://github.com/haskell/haddock/issues/472#issuecomment-257136046 。不过,我不会屏住呼吸——这需要对 Haddock 存储文档字符串的方式进行一些真正的核心更改。


推荐阅读