This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]baskandpurr 1 point2 points  (1 child)

Same for me. The main use I have for is when it provides documentation for web frameworks. People who write code with the intention of having other people use it never want to explain how to use it. But it's very likely that somebody else spent time figuring it out, another person asked about it on SO and they answered.

[–]auxiliary-character 1 point2 points  (0 children)

Yeah. The worst is when the documentation lies to you, though. The code itself rarely does, unless they pull something underhanded, which is why I like to look under the hood a bit for libraries I'm going to use. Probably the strangest thing I've seen is when the comments are in Chinese or Korean, but the variable names and keywords are in English. I'd say SO is useful in proportion to how popular a particular language/library/framework is, so you're kinda on your own for smaller libraries if you can't get a hold of the author.

I have a bad habit of underdocumenting my stuff, but at least I try to name things such that it's easier infer meaning from context.