opciones - if en haskell ejemplos

¿Qué significa generalmente un comentario de Haskell que comienza con `{- |`?

Question

Veo comentarios de múltiples líneas de Haskell que a veces comienzan con {- | en lugar de solo {- .

¿Liderar con el personaje principal dentro del comentario significa algo por convención?

Answer 1

El | al comienzo de un comentario es la sintaxis de Haddock que comienza una anotación de documentación. Un ejemplo de la documentación de Haddock es:

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

También va a decir

La sintaxis "- |" comienza una anotación de documentación, que se aplica a la siguiente declaración en el archivo fuente. Tenga en cuenta que la anotación es solo un comentario en Haskell; el compilador de Haskell la ignorará.