News Feed
Jobs Feed

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

Shawn Stratton's Blog:
Code Readability, Part 1
January 13, 2009 @ 10:20:28

Shawn Stratton has posted the first part of his series looking at "Code Readability". This part focuses on something that is often woefully forgotten by many developers - proper code commenting.

The simplicity of PHP can sometimes be overwhelming, with so many different ways and approaches to creating solutions for our problems we sometimes lose the ability to think past the current problem and into the future. [...] Today I'm going to try to address some quick ideas that most of you will already be familiar with, things that will aide in the general readability of code for future generations.

He looks at the difference between useful and non-useful comments: DocBlocks, putting them near decisions, listing array parameters, recording TODOs and how it can all help you generate API documentation quickly and easily.

0 comments voice your opinion now!
readability docblock comment useful series

blog comments powered by Disqus

Similar Posts Digg-style AJAX comment editing in PHP/symfony

Dutch Web Alliance: The definitive remote debug and unittest with PHPStorm guide

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

SitePoint PHP Blog: Tim\'s comment challenge...

SitePoint PHP Blog: Ubuntu Add-Ons with PHP

Community Events

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

overview component application podcast hhvm composer opinion performance package facebook security unittest hack language symfony2 database introduction framework install release

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