以“{-|”开头的Haskell注释通常意味着什么?

以“{-|”开头的Haskell注释通常意味着什么?,haskell,haddock,Haskell,Haddock,我看到Haskell的多行注释有时以{-|开头,而不仅仅是{- 注释中以管道字符开头是否意味着某种约定?注释开头的是文档注释的开头语法。Haddock文档中的一个示例是: -- |The 'square' function squares an integer. square :: Int -> Int square x = x * x 它还接着说 “-|”语法开始一个文档注释,该注释适用于源文件中的以下声明。请注意,该注释只是Haskell中的注释-Haskell编译器将忽略它 具体来

我看到Haskell的多行注释有时以
{-|
开头,而不仅仅是
{-


注释中以管道字符开头是否意味着某种约定?

注释开头的
是文档注释的开头语法。Haddock文档中的一个示例是:

-- |The 'square' function squares an integer.
square :: Int -> Int
square x = x * x
它还接着说

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


具体来说,它是关于注释后面的内容的注释,而
--^
描述注释前面的内容。