News Feed

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

Brandon Savage's Blog:
Peer Review Managing Coding Standards
August 17, 2009 @ 10:28:04

Brandon Savage has posted a few suggestions about dealing with coding standards and how they can help improve the quality of your code via his refactoring of a bit of example code. This time the focus is on documentation.

One of the first things I look for when I check out code is how is the code organized? Is it laid out well? Is it coded to a particular standard? In our code sample, the first thing we should address is how does the code look. There are a number of suggestions I would make immediately.

His list includes four suggestions for/comments about different areas of his example code:

  • There are no DocBlocks or clear coding standards
  • Examining The Properties (comments of the class properties)
  • Conditionals (changing inline to braced)
  • Improving The Constructor (to make it more flexible)
0 comments voice your opinion now!
peerreview coding standard documentation

blog comments powered by Disqus

Similar Posts

Richard Rodger: Why I Have Given Up on Coding Standards

Brandon Savage's Blog: Why Coding Tests Are A Bad Interview Technique

Scott Mattocks's Blog: PHP-GTK News #17 Enforcing Coding Standards with PHP_CodeSniffer

Scott Mattocks: D is for Documentation

Community Events

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

series introduction api library symfony2 performance extension interview release example voicesoftheelephpant application laravel podcast conference framework community opinion version php7

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