posted on Saturday, May 15, 2004 3:27 PM by demiliani

Comments on code...

Inspired by Jay Kimble's post “Real Programmers... don't use comments??!!, I want to say my personal opinion about comments in code.

I think that code (expecially if it's part of a big project) must always be well commented. A "well commented" code is more simple to understand for others and more simple to maintain.

I'm totally disagree with the affermation that “comments are useless; if you can't read my code and understand it, you shouldn't be in it.” ... for me this is terrible wrong.

Comments are useful for the program's author when he has to do some modification on the code and a lot of time is passed from the last revision (my personal experience says that reading good comments is fast than try to understand all the code) and it's extremely important for other people that could work with your code.

If you have a big project and work in team, a "well-commented" code is foundamental. Other programmers must understand not only your code, but the idea associated with your code (function, routine etc.).

Comments are the only way to clearify your idea... so, my advice: "Real Programmers, please use comments!!!"

Comments