有没有办法先在Haddock中描述函数参数?

时间:2014-12-08 21:33:39

标签: haskell haddock

典型的 Haddock 语法允许编写类似这样的内容

-- Initializes local variables so arrays will get defined
--
-- Defer initialization context inside a compound type.
-- 
initialize :: Bool      -- ^ 1st parameter description  
           -> Type      -- ^ 2nd parameter description
           -> [Signal]  -- ^ 3rd parameter description
           -> Structure -- ^ 4th parameter description
           -> Doc       -- ^ result value desription
initialize _ (MachineVector 1 Pointer{}) = equals <+> text "NULL"

我想用Java方式编写它,我在函数签名之前有参数描述。我有更复杂的签名,所以这种方法打破了可读性。 有没有办法这样写?

-- Initializes local variables so arrays will get defined
--
-- Defer initialization context inside a compound type.
-- 
-- ^ 1st parameter description
-- ^ 2nd parameter description
-- ^ 3rd parameter description
-- ^ 4th parameter description
-- ^ result value desription
initialize :: Bool->Type->[Signal]->Structure->Doc       
initialize _ (MachineVector 1 Pointer{}) = equals <+> text "NULL"

1 个答案:

答案 0 :(得分:8)