On Code Commenting And Technical Debt

If you’ve been in development for any length of time, you’ve probably come across a project or a company that doesn’t take the time to incorporate comments into its code. The argument is often made that “our code is self-documenting” and that commenting is just a waste of time, especially if you write clear, clean code. But I disagree.

Some people take a different view of commenting than others. Most recently, Eli White wrote an article called “Commenting on Commenting” in which he argued for commenting virtually every single line of code. He talked about working for a company where they stripped the code out and turned the comments into line-by-line documentation. But commenting to me is important for a different reason:

(more…)

Wednesday, April 29th, 2009 @ 12:30 pm | Comment (12) | Categories: Best Practices
Tags: , , ,


Copyright © 2022 by Brandon Savage. All rights reserved.