![]() |
|
Problems? Is your data what you think it is? | |
PerlMonks |
Re: flower box commentsby EdwardG (Vicar) |
on Nov 17, 2003 at 10:06 UTC ( #307613=note: print w/replies, xml ) | Need Help?? |
What I have seen is that this style of comment (in particular) tends to grow less accurate as it passes through iterations of maintenance. Eventually it becomes just wrong, for example referring to parameters that are no longer used, or describing the original purpose that no longer applies. And if you don't trust the comment, you have to read the code, and if you end up reading the code then why bother with this type of comment in the first place. It could also be argued that this style of comment is a form of code duplication, complete with the same maintenance issues. Of course I want to see helpful comments, particularly for dense or terse code, but frankly I've developed a form of comment-blindness, triggered by code like this:
(Exaggerated for dramatic effect)
In Section
Seekers of Perl Wisdom
|
|