News Feed

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

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

Larry Garfield's Blog: PHP project structure survey Ruby on Rails makes nice with PHP

Alan Skorkin's Blog: What Every Developer Should Know About URLs 9 Confusing Naming Conventions for Beginners

Vinícius Krolow: Some tips to improve your codes readability

Community Events

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

community project yii2 api framework composer podcast laravel application symfony conference language opinion php7 interview part2 series example list introduction

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