1. ホーム
  2. haskell

[解決済み] 一般的に `{- |` で始まるHaskellのコメントは何を意味するのですか?

2022-02-03 21:47:48

質問事項

Haskellの複数行のコメントで、ときどき {- | ではなく、単に {- .

コメント内のパイプ文字でリードするのは、慣習的に何か意味があるのでしょうか?

どのように解決するのですか?

その | は、コメントの先頭に ハドック の構文で、ドキュメントの注釈を開始します。Haddockのドキュメントの例を挙げます。

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

さらに、次のように続きます。

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