in reply to Re: The art of comments: (rave from the grave)
in thread The art of comments: (rave from the grave)
Limbic~Region. In part, my reason for asking for links of what people found to be good examples was an attempt to discover whether anyone ever found somebody elses comments good, rather than just their own (idea of what would make) good commenting.
My own contention is that:
That's not to say that there aren't good uses for comments. Just that over time, they become less good.
Personally, if find it easier to write the code than a (good) comment about it.
Historically I've found that if I don't understand the code, the associated comments rarely help and often hinder. Indeed, if I want to work out what a compex piece of code is doing, especially if it is my intention to modify that code, I found that deleting the comments and reading the code is the only way (for me).
Occasionally, if the commenting is detailed enough, it serves to show up a distinction between what the author thought they were coding and what they actually coded--which I guess serves a purpose, but any commenting that is detailed enough for that to be true, will usually be described as "over-commented", even by those that encourage commenting.
|
---|
Replies are listed 'Best First'. | |
---|---|
Re^3: The art of comments: (rave from the grave)
by hv (Prior) on Jul 07, 2005 at 20:54 UTC |