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

PHP in Action:
Comments Considered Harmful
Dec 24, 2008 @ 13:41:38

In this new post from the PHP in Action blog, they comment on Eli White's comments on commenting.

There is too much old advice in PHP. A recent case comes from the PHP Advent calendar. Eli White is a strong believer in commenting code, including inline comments inside functions. Unfortunately, he's at least 10 years too late. This used to be good advice, but not any more. Up to a point, he's right.

They propose a better way - refactoring code so that its as easy to read as possible, reducing the need for extensive commenting. They illustrate with a rework from the Zend Framework function, changing up the method names to better reflect the action inside (rather than the current "doUpdate").

tagged: comment harmful refactor understand zendframework