Ask HN: Best documentation in code you have seen?

by zzimbler on 12/12/2012, 9:31:29 PM with 6 comments
What is the best documentation in code you have seen?

  • by brockrockman on 12/12/2012, 11:36:15 PM

    http://paste.lisp.org/display/133628

  • by ScottWhigham on 12/13/2012, 2:53:06 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 brotchie on 12/13/2012, 2:08:16 AM

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

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

  • by veeti on 12/12/2012, 11:09:05 PM

    Qt has amazing API documentation.

  • by eduardordm on 12/13/2012, 1:36:17 AM

    Hands down: JDK.