web-dev-qa-db-ja.com

`{-|`で始まるHaskellコメントは一般的にどういう意味ですか?

Haskellの複数行コメントが、単に{- |ではなく{-で始まる場合があります。

コメント内のパイプ文字で先行することは、慣例により何かを意味しますか?

34
dan

|コメントの先頭は Haddock であり、ドキュメントの注釈を開始します。 Haddockドキュメントの例は次のとおりです。

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

それはまた言い続けます

「-|」構文は、ソースファイル内の次の宣言に適用されるドキュメントアノテーションを開始します。注釈はHaskellの単なるコメントであることに注意してください— Haskellコンパイラーによって無視されます。

42
Lily Ballard