以`{ - |`開頭的Haskell評論通常意味着什麼？

Question

我看到Haskell多行註釋有時以{- |開頭，而不僅僅是{-。

在評論中是否以管道字符開頭是否意味着按照慣例？

Answer 1

|在評論開始時是Haddock開始文檔註釋的語法。從黑線鱈文檔的一個例子是：

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

它還接着說

的「 - |」語法開頭的文檔註釋，它適用於在源文件中的以下聲明。請注意，註釋只是Haskell中的註釋 - 它將被Haskell編譯器忽略。