We don't bite newbies here... much | |
PerlMonks |
Re^2: The art of comments: (rave from the grave)by cees (Curate) |
on Jul 07, 2005 at 15:18 UTC ( [id://473120]=note: print w/replies, xml ) | Need Help?? |
I like these types of comments as well, but I also find that lots of programmers tend lie in these comments. The comment may have been accurate at one point, but a small API change altered the behaviour of the function, yet the comment was never updated. I have seen this is my code (*blush*) as well as in others, and it can really throw you off. Here is a maxim that I usually go by: The farther away a comment is from the code it tries to explain the less reliable it is.
In Section
Meditations
|
|