No, you're just making one of the classic blunders of a beginning programmer (when first told that you should comment your code). Here's an excerpt from an article on anti-patterns in the latest (Feb. 2003) Dr. Dobbs journal:

We are all familiar with the basic duh comment

i++; //add one to i

that is an unsung foundation of antipatternery. But, in fact, it does no more damage than clutter the layout and could even be argued to be useful in that it warns the reader that the module-writer is quite thick.

But don't feel bad...the author goes on to reveal a good commenting blunder of her own...we've all made these mistakes at sometime or another, it's just a matter of (un)learning (from) them.

this would help them out greatly!!

No, it would only stop them from reading documentation. Don't give too much information.

- Yes, I reinvent wheels.
- Spam: Visit eurotraQ.