Ask HN: Best documentation in code you have seen?

by zzimbleron 12/12/2012, 9:31 PMwith 6 comments

What is the best documentation in code you have seen?

by ScottWhighamon 12/13/2012, 2:53 PM

This 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.

by brotchieon 12/13/2012, 2:08 AM

Not exactly what you're asking for, but Ratchet's landing page documentation is very slick.

http://maker.github.com/ratchet/

by veetion 12/12/2012, 11:09 PM

Qt has amazing API documentation.

by eduardordmon 12/13/2012, 1:36 AM

Hands down: JDK.