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

Question

我看到Haskell多行注释有时候会开始{- |而不仅仅是{-.

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

Answer 1

将|在注释的开头是黑线鳕语法开始一个文档注释.Haddock文档中的一个例子是:

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

它还接着说

" - |"语法开始一个文档注释,它适用于源文件中的以下声明.请注意,注释只是Haskell中的注释 - 它将被Haskell编译器忽略.