Commenting code guidelines

Posted on August 1st, 2005 by

Attention programmers, Ryan Campbell at particletree has posted some really great guidelines for commenting your code.

Commenting your code is like cleaning your bathroom–you never want to do it, but it really does create a more pleasant experience for you and your guests. Because I’ve recently adopted a new mantra to use comments frequently and appropriately in my code, I spent a few hours researching the literature on commenting readability, reusability, and guidelines.

Now only if everybody actually followed them…

 

Comments are closed.