News Feed
Jobs Feed
Sections




News Archive
Shawn Straton's Blog:
Code Readability Part 2, Code Structure
January 19, 2009 @ 12:59:41

Shawn Straton has posted the second part of his look at code readability today. This time the focus is on the structure of the code - file structure, code layout, etc.

I've had the pleasure of maintaining a legacy application developed by people who were past deadline the second they had their assignment handed to them in the past and it can get really interesting rather quickly when you see how sloppy you can get when you are in such a hurry. Here are some guidelines I've given myself to ensure that the structure is correct at the end of the day.

Some of his suggestions include:

  • Breaking larger files apart into smaller, easier to maintain pieces
  • Correctly naming functions/variables/etc
  • Tabbing/spacing in to indent code blocks
  • Input validation and error checking should always be included
0 comments voice your opinion now!
readable maintain structure naming convention


blog comments powered by Disqus

Similar Posts

Yet Another Web Development Blog: Dear PHP, I think it's time we broke up.

Jeff Moore's Blog: Why is PHP Code Considered Hard to Maintain?

SitePoint PHP Blog: PHPBench.com: Live PHP benchmarks, demystifying "best practices"

SocialGeek.be: Clean urls through readable slugs in PHP

PHPKitchen: Advantages of using the PEAR class naming convention


Community Events











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


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

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