News Feed
Jobs Feed
Sections



Recent Jobs

News Archive
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



Similar Posts

Lukas Smith's Blog: PHP adopting branching kicking and screaming

DevShed: Creating the Blog Script for a PHP/MySQL Blogging System (Part 2)

The Codist Blog: I Will Never Understand the Appeal Of PHP

Rafael Dohms' Blog: PHP Security: Are you paying attention?

Gonzalo Ayuso's Blog: First impressions about namespaces in PHP


Community Events

phpnw10 PHP Conference 09/10/2010




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


opinion development tool unittest suggestion book example conference azure symfony developer framework wordpress database plugin application zendframework codeigniter podcast phpunit

All content copyright, 2010 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework