CodingStandards

NOCC Coding Standards

• NOCC Coding Standards
  • Indenting and Line Length
  • Control Structures
  • Function Calls
  • PHP Code Tags
  • Naming Conventions

Most of the coding standards have been taken from the PEAR Coding Standards.

Indenting and Line Length

Use an indent of 4 spaces, with no tabs.

Control Structures

These include if, for, while, switch, etc. Here is an example if statement, since it is the most complicated of them:

<?php
if ((condition1) || (condition2)) {
    action1;
}
elseif ((condition3) && (condition4)) {
    action2;
}
else {
    defaultaction;
}
?>

Control statements should have one space between the control keyword and opening parenthesis, to distinguish them from function calls.

You are strongly encouraged to always use curly braces even in situations where they are technically optional. Having them increases readability and decreases the likelihood of logic errors being introduced when new lines are added.

For switch statements:

<?php
switch (condition) {
    case 1:
        action1;
        break;

    case 2:
        action2;
        break;

    default:
        defaultaction;
        break;
}
?>

Function Calls

Functions should be called with no spaces between the function name, the opening parenthesis, and the first parameter; spaces between commas and each parameter, and no space between the last parameter, the closing parenthesis, and the semicolon. Here's an example:

<?php
$var = foo($bar, $baz, $quux);
?>

PHP Code Tags

Always use <?php ?> to delimit PHP code, not the <? ?> shorthand.

Naming Conventions

...