Representative Line: What it Doesn't Do
by Remy Porter from The Daily WTF on (#79H5D)
Alastair found this comment in his codebase, and wondered, "who wrote this comment?" A quick blame answered the question: he did. He did not, however, write the code.
public function getAllMailers() { // This function neither returns Mailers, nor all of them. ... }I suppose the comment was easier to add that doing a global find/replace to update the function name everywhere. But I do wonder, what does this function return?
In any case, sing along: "I wrote the comment, but I did not pick this function name".