News Feed

News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

Jani Hartikainen's Blog:
Is commenting your code useless?
October 16, 2009 @ 09:45:03

Jani Hartikainen has posted some of his opinions about code commenting in a response to this post from James Carr claiming that code comments on fresh code is a bad idea.

James puts it quite well: When you write comments, it would be much better idea to just talk with your coworkers about it. He uses "excuses" as an example - code which does something that you need to explain, or says something like "Here we do X but we should really do Y" While I partially agree - if you're not sure which approach you should use, or whether your approach is correct, talking with your coworkers is definitely a good idea.

Jani talks a bit about what he considers good and bad commenting - non-redundant, descriptive and sometimes difficult to remember to do correctly.

0 comments voice your opinion now!
comment code opinion

blog comments powered by Disqus

Similar Posts Why experienced developers consider Laravel as a poorly designed framework?

Stefan Koopmanschap's Blog: Your error page can be better

Laura Thompson: The dark craft of engineering management

Kevin Schroeder's Blog: The best developers hit F5 10 Tips for Better Coding

Community Events

Don't see your event here?
Let us know!

symfony programming language framework list yii2 api php7 community laravel composer application podcast interview opinion example part2 series project introduction

All content copyright, 2015 :: - Powered by the Solar PHP Framework