News Feed
Jobs Feed
Sections




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

PHP in Action: How harmful is "harmful"?

IBM developerWorks: Setting up your own on-demand video site with PHP, Part 1

Padraic Brady's Blog: Example Zend Framework Blog Application Tutorial: Parts 1-8 Revisited

Davey Shafik's Blog: Return Values

PHP Thinktank Blog: PHP-GTK with scottmattocks (IRC Talk Series)


Community Events











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


opinion series object community podcast development unittest testing language example conference framework introduction functional code tool zendframework2 interview phpunit release

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