Scripting Guidelines/it

Commenti

Tutte le funzioni, classi o "strange" e script complessi sono commentati in modo da aiutare gli sviluppatori per capire come funziona il tutto.

Al momento lo stile del commento non è importante, può essere del tipo multilinea /* */ o in singola linea //

/*
 Inserisci qui il tuo commento
 multilinea
*/

// Inserisci qui il tuo commento in semplice linea.

Rientro codice

Per mantenere una corretta visualizzazione del codice è importante il rientro del codice in modo da avere un codice chiaro e piacevole da farlo capire anche agli altri sviluppatori.

class myClass() {
var $foo = "Foo";
function myFunction() {
echo $this->foo;
}
}
 
function foo()
{
global $dblink;
if (condition)
{
echo "True";
}
else
{
echo "False";
}
}

class myClass() {
    var $foo = "Foo";
    function myFunction() {
        echo $this->foo;
    }
}
 
function foo() {
     global $dblink;
     if (condition) {
          echo "True";
     } else {
          echo "False";
     }
}

Allineamento

L'allineamento di questo codice è molto importante.

$myArray = array(
    'One'   => '1',
    'Two'   => '2',
    'Three' => '3',
    'Four'  => '4',
    'Five'  => '5'
)
 
$var      = myFunction($var);
$variable = myFunction($var);
$another  = myFunction($var);

Dichiarazione if

Non usare funzioni lunghe con il comando if:

if (cond) {
    //...
} else if (cond2) {
    //...
} else if (cond3) {
    //...
} else {
    //...
}

Usa il comando switch:

switch ($var) {
    case 1:
        //...
    break;
    case 2:
        //...
    break;
    case 3:
        //...
    break;
    default: //Pagina di default
        //...
    break;
}

HTML tags

Non utilizzare la forma XHTML (con slash) nel tag di chiusura.

<input ..... /><br />

Ricorda che il DOCTYPE sul MemHT è HTML 4.01 Transitional

<input .....><br>