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

Danne Lundqvist's Blog: Getting to grips with an existing XML structure

Ajax Magazine: Claw, PHP5 MVC Framework Ajaxified

Reddit.com: Let's Make PHP's Function Names Consistent!

PEAR Blog: PEAR Group Meeting Minutes 2008-07-13

Josh Adell: Interfaces and Traits: A Powerful Combo


Community Events









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


interview podcast zendframework2 code language community opinion introduction event composer framework tool database phpunit object development release unittest example testing

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