Developer coding guidelines Jun 17, 2009
Coding Style
Zenphoto code follows some basic style guidelines. We essentially use the 1TBS variant of the K&R notation C-code syntax, for example:
function foo($bar) {
if ($bar == 2) {
return $bar;
} else if ($bar < 2) {
while($bar < 2) {
echo $bar;
$bar++;
}
}
}
This is a fairly standard formatting for PHP code and makes things nice and readable.
A few guidelines for coding in general:
- Use generalization and abstraction. DRY! (Don't Repeat Yourself).
- Keep it simple - if something seems too complex it probably is.
- Keep efficiency in mind - try not to put filesystem operations in nested loops for example.
- Write clean code! Make things readable and understandable.
- Comment your code so that others can understand it. Remember we are open source. For function comments we generaly follow the (...)
