Home Blog Programming Commenting your code

Commenting your code

Written by Peter R. Bloomfield | Thursday, 17 April 2008 08:52 | 0 comments
Any developer who was worked with me, or just seen my code, will know that I am practically obsessive-compulsive about quality. I hate leaving unreadable code, loose ends or potential bugs, so I flesh out and refine my algorithms all the time, and try to consider every eventuality in advance.

More than that, I comment my code as if my life depends on it. Seriously. And even moreso now that I commonly use phpdocumentor and Doxygen more. As such, I particularly appreciated an article on DevTopics.com, which lists "13 tips to comment your code".

Programmers out there need to heed the advice and write better code! I know it's normally not possible to make everything bullet-proof, and perhaps I try a little too hard in that regard, but massive chunks of unreadable code with no explanatory comments is not a good idea... no matter what your budget or schedule is like.

Even if you think you're a good programmer, still check out those tips. Commenting your code is crucial, so go on! Just try it!

Add new comment