Haddock 超链接并且没有关于冗余导入的警告

Question

我的项目中有一个虚拟模块，其唯一目的是保存库其余部分的 Haddock 文档。事实上，我不需要导入此模块中的任何内容，但如果我不导入其他模块，Haddock 不会将函数名称超链接到其模块。

我的模块看起来像这样

{- |

Lots of Haddock text here... it references 'someFunction'.

-}
module TopLevelDoc () where

import Other.Module.With.SomeFunction

现在，如果我构建项目，我会收到此警告：

    Warning: The import of `Other.Module.With.SomeFunction' is redundant
           except perhaps to import instances from `Other.Module.With.SomeFunction'
         To import instances alone, use: import Other.Module.With.SomeFunction()

如果我删除导入或将它们设为 ()，Haddock 不会将 someFunction 超链接到其文档。如果我按原样保留此类导入，我会收到很多错误警告，这是我不喜欢的。我不想在整个项目中抑制这种警告，它可能对除了这个模块之外的任何其他模块都有用。

问题：

1. 如何在构建时获得超链接的 Haddock 输出而不出现此类警告？
2. 是否可以针对每个文件禁用警告？ （就像我可以使用 .cabal 中的 ghc-options 进行全局操作一样）

Answer 1

要消除未使用的导入警告，您可以在文件顶部放置一个编译指示：

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

您可以通过显式限定它们来链接到不在范围内的标识符：

还可以通过给出实体的完整限定名称来引用不在当前模块范围内的实体：

<前><代码>-- |标识符“MT”不在范围内

如果 MT 不在范围内，那么 Haddock 将简单地发出一个指向从模块 M 导出的实体 T 的链接（而不检查 M 或 MT 是否存在）。

— Haddock 用户指南

但是，这可能会使您的文档源代码相当难看，并且模块限定条件不会从输出中删除，因此我建议关闭警告。