Monthly Archives: July 2010

Code commenting with Doc Blocks

Code commenting can be a pain. If its your code then you know exactly what it does and why. If its someone else’s code – then all of a sudden they are invaluable. The Doc Block commenting style is a widely used standard for commenting accross all languages, and can also be used to generate code hints and automatic documentation if used properly.

The following guide to code-commenting is taken from: http://net.tutsplus.com/tutorials/php/object-oriented-php-for-beginners/

Continue reading