如何使用Haddock减少文档重复

Question

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

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

例如在Javadoc中有{@inheritDoc}和@see SomeClass#someMethod()。哈多克怎么样？

Answer 1

不幸的是，目前函数声明不可能有Haddock的可重用文档。以下是issue跟踪此内容。

-- $chunk_name文档chunk naming仅适用于模块文档，即导出部分。这对于将文档从模块顶部移动到底部以减少混乱来说非常方便。

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

• 确保类似的功能在范围内并将其添加到文档中： -- | See `functionName`. OR -- | See 'functionName'.
• 或手动复制和粘贴文档（如果文档足够小，类似于bytestring和vector包中的文档。