以{ - |`开头的Haskell注释通常意味着什么？

Question

我看到Haskell多行评论有时以{- |开头，而不仅仅是{-。

引用注释中的管道符号是否符合惯例？

Answer 1

评论开头的|是开始文档注释的Haddock语法。 Haddock文档中的一个例子是：

-- |The 'square' function squares an integer.
square :: Int -> Int
square x = x * x

还接着说

  

“ - |”语法开始文档注释，该注释适用于源文件中的以下声明。请注意，注释只是Haskell中的注释 - 它将被Haskell编译器忽略。