Skip to main content
Shop Support Downloads
IBM Home Products Consulting Industries News About IBM
IBM developerWorks : Web Architecture : Education - Tutorials
Writing efficient PHP
ZIPPDF (letter)PDF (A4)e-mail
Main menuSection menuFeedbackPreviousNext
2. Writing efficient code

Avoiding comments that fail to add value page 9 of 15

Some developers have a habit of adding a short comment consisting of just their initials, or sometimes their initials and the date. These comments rarely add any value to the code for anyone but the programmer who inserted them. Additionally, do not consider such comments documentation.

If you need a comment to explain the code, add information that will be helpful to other developers. If not, leave the comment out. It clutters up the code and potentially adds a small overhead in any scripting language.

Main menuSection menuFeedbackPreviousNext
Privacy Legal Contact