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 The new documentation build system is ready for testing

Alexander Netkachev's Blog: Zend Framework News

Lorna Mitchell: How NOT to Design Your API

David Otton's Blog: PHP Tip: Classes Arenít Derived From stdClass

Volker Dusch's Blog: Please ship your own coding standard as part of your project

Community Events

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

symfony library laravel community version introduction security language series update framework opinion voicesoftheelephpant package release interview mvc tool composer podcast

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