Ask HN: Are Funny Code Comments Useful?(webmaster-talk.com)
webmaster-talk.com
Ask HN: Are Funny Code Comments Useful?
http://www.webmaster-talk.com/coding-forum/120595-funny-code-comments.html
8 comments
I just found this. Apparently the Linux kernel is primarily written by sailors.
http://www.vidarholen.net/contents/wordcount/
http://www.vidarholen.net/contents/wordcount/
/* WTF IS THIS */ can actually speak volumes about code, though.
Of course they are. Humor is useful. We tracked down a bug in our code the other day to one of the hard-coded internal constants being too high... It had the comment "I sort of just made this up. Probably worth testing." If it had been commentless, we would have worried by moving it we'd fix our use-case but break some other use-case.
I don't think that's an example of humor in comments -- it's just saying, "I'm not sure this is right, you should test it." That's pretty important, actually.
I think the question is more about comments that are just puns or something, like:
I think the question is more about comments that are just puns or something, like:
p = point(w, 0, 0); /* woo hoo! */What's useful there is not the humor but the information.
I ocasionally find myself writing, "Warning: obscenely hackalicious hackety hack", or something similar. When I come across it later, it makes me laugh and makes me refactor.
Did this make the project go faster, and development more fun, or was it just distracting?
Funny examples of your own would be appreciated.