3 ms·
Ask HN: Best documentation in code you have seen?
What is the best documentation in code you have seen?
- veeti 14y agoQt has amazing API documentation.
- brockrockman 14y agohttp://paste.lisp.org/display/133628 http://paste.lisp.org/display/133628
- S4M 14y agoDude, this is like a course on the imaginary numbers. I am stunt someone would put that in the documentation of a code!
- eduardordm 14y agoHands down: JDK.
- brotchie 14y agoNot exactly what you're asking for, but Ratchet's landing page documentation is very slick. http://maker.github.com/ratchet/ http://maker.github.com/ratchet/
- ScottWhigham 14y agoThis is interesting - when I read your post, I thought, "What a strange question. The best documentation is just the one that explains the problem in a simple, easy to understand manner." You see, I was thinking "in code" as in "// This comment explains the logic in the next code block". And then when I read the comments from others, at the time of this response everyone has chosen that the word "documentation" refers to a "body of knowledge that ships with the product". It's funny how we all interpret this differently.