4 ms·
How do you do documentation in Haskell? For Python and Clojure, there's docstrings. For Java there's Javadoc. For Haskell, there doesn't seem to be any well-est
by mushly 13y ago
How do you do documentation in Haskell? For Python and Clojure, there's docstrings. For Java there's Javadoc. For Haskell, there doesn't seem to be any well-established documentation practices.
This is of course not counting the occasional comment explaining why/how you're doing something convoluted.
- dllthomas 13y agoThere is haddock and literate haskell. Types also serve as some documentation.
- quchen 13y ago> For Haskell, there doesn't seem to be any well-established documentation practices. Oh yes but there is! It's called Haddock. It's widely (and probably exclusively) used. The entirety of the documetation you can find on Hackage [1] (example: [2]) is generated using it. The user guide can be found here [3]. [1]: http://hackage.haskell.org/ http://hackage.haskell.org/ [2]: http://hackage.haskell.org/package/pipes-4.1.0/docs/Pipes-Prelude.html http://hackage.haskell.org/package/pipes-4.1.0/docs/Pipes-Pr... [3]: http://www.haskell.org/haddock/doc/html/ http://www.haskell.org/haddock/doc/html/