Project

General

Profile

Actions

Code Standards » History » Revision 12

« Previous | Revision 12/21 (diff) | Next »
Amber Herold, 12/10/2010 03:20 PM


Code Standards

If everyone uses the same coding style, it is much easier to read code that someone else wrote. That said, style is not important enough to enforce during a code review. It is much more important to ensure that best practices are followed such as implementing error handling .

Python

Python Style Guide
Python Coding Standards

PHP

This one is a bit old, but lots of good stuff that goes beyond style. Some things are questionable. I prefer Getters/Setters over Attributes as Objects (at least how the example shows it) to allow for better error handling. I prefer no underscores in naming except for constants that use all caps...but that is only a style issue.

PHP Coding Standard

From the Zend framework folks:
http://framework.zend.com/manual/en/coding-standard.html

An intro:
http://godbit.com/article/introduction-to-php-coding-standards

Nice Presentation:
http://weierophinney.net/matthew/uploads/php_development_best_practices.pdf

PHP Unit testing
http://www.phpunit.de/pocket_guide/

For automatically checking code against the Pear standards use CodeSniffer:
http://pear.php.net/package/PHP_CodeSniffer/

Any Language

DRY principle : Don't Repeat Yourself
Joomla guide

Updated by Amber Herold about 14 years ago · 12 revisions