haskell - 如何使用 Haddock 减少文档重复

Question

我有两个非常相似的功能，并且都需要完全相同的文档。黑线鳕有没有办法避免评论重复？

我在 Haddock 文档中找不到此功能的描述，但我想有办法做到这一点。

例如在 Javadoc 中有 {@inheritDoc}和 @see SomeClass#someMethod() .黑线鳕呢？

Answer 1

不幸的是，函数声明目前不可能有可重用的 Haddock 文档。这是 issue跟踪这个。
-- $chunk_name文档 chunk naming仅适用于模块文档，即导出部分。这仅适用于将文档从模块顶部移动到底部以减少困惑。

此问题的常见解决方法是:

确保类似的功能在范围内，并将其添加到文档中:
-- | See `functionName`.
OR
-- | See 'functionName'.


如果文档足够小，则手动复制和粘贴文档，类似于 bytestring 中的操作方式和 vector包。