如何使用 Haddock 减少文档重复

How to reduce documentation duplication using Haddock

我有两个非常相似的功能,并且都需要完全相同的文档。 Haddock 有没有办法避免评论重复?

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

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

不幸的是,函数声明目前不可能有 Haddock 的可重用文档。这是一个 issue 跟踪这个。

-- $chunk_name 文档 chunk naming 仅适用于模块文档,即导出部分。这仅在将文档从模块顶部移动到底部以减少混乱时方便。

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

  • 确保类似功能在范围内并将其添加到文档中: -- | See `functionName`. OR -- | See 'functionName'.
  • 或者手动复制和粘贴文档(如果它足够小),与 bytestringvector 包中的操作类似。