典型的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"
查看Haddock源代码,看起来好像没有,因为函数参数仅从内部类型中提取。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句