Haskell 如何使用Haddock减少文档重复
我有两个非常相似的函数,它们都需要完全相同的文档。Haddock中有没有避免注释重复的方法 我在Haddock文档中找不到这个特性的描述,但我想有一种方法可以做到这一点Haskell 如何使用Haddock减少文档重复,haskell,haddock,Haskell,Haddock,我有两个非常相似的函数,它们都需要完全相同的文档。Haddock中有没有避免注释重复的方法 我在Haddock文档中找不到这个特性的描述,但我想有一种方法可以做到这一点 例如,在Javadoc中有{@inheritardoc}和@请参见SomeClass#someMethod()。Haddock呢?不幸的是,函数声明目前不可能在Haddock中包含可重用的文档。这是一个跟踪这个的程序 -$chunk\u name文档仅适用于模块文档,即导出部分。这仅适用于将文档从模块顶部移动到底部以减少混乱 此
例如,在Javadoc中有
{@inheritardoc}
和@请参见SomeClass#someMethod()
。Haddock呢?不幸的是,函数声明目前不可能在Haddock中包含可重用的文档。这是一个跟踪这个的程序
-$chunk\u name
文档仅适用于模块文档,即导出部分。这仅适用于将文档从模块顶部移动到底部以减少混乱
此问题的常见解决方法有:
- 确保类似功能在范围内,并将其添加到文档中:
--|参见“函数名”。 或 --|参见“函数名”。
- 或者,如果文档足够小,则手动复制并粘贴文档,类似于在
和bytestring
包中执行的方式vector
——|参见“函数名”
,我们可以用这个例子扩展答案吗