PHP - Standard di codifica

Ogni azienda segue uno standard di codifica diverso in base alle proprie migliori pratiche. Lo standard di codifica è richiesto perché potrebbero esserci molti sviluppatori che lavorano su moduli diversi, quindi se inizieranno a inventare i propri standard, il sorgente diventerà molto ingestibile e sarà difficile mantenere quel codice sorgente in futuro.

Ecco diversi motivi per utilizzare le specifiche di codifica:

  • I tuoi programmatori peer devono capire il codice che produci. Uno standard di codifica funge da modello per tutto il team per decifrare il codice.

  • La semplicità e la chiarezza ottenute da una codifica coerente ti evitano gli errori comuni.

  • Se rivedi il tuo codice dopo un po 'di tempo, diventa facile capire quel codice.

  • Il suo standard industriale per seguire uno standard particolare per essere più di qualità nel software.

Ci sono poche linee guida che possono essere seguite durante la codifica in PHP.

  • Indenting and Line Length- Utilizza un rientro di 4 spazi e non utilizzare alcuna scheda perché computer diversi utilizzano impostazioni diverse per la scheda. Si consiglia di mantenere una lunghezza delle righe di circa 75-85 caratteri per una migliore leggibilità del codice.

  • Control Structures- Questi includono if, for, while, switch, ecc. Le istruzioni di controllo dovrebbero avere uno spazio tra la parola chiave control e la parentesi aperta, per distinguerle dalle chiamate di funzione. Sei fortemente incoraggiato a usare sempre le parentesi graffe anche in situazioni in cui sono tecnicamente facoltative.

Examples

if ((condition1) || (condition2)) {
   action1;
}elseif ((condition3) && (condition4)) {
   action2;
}else {
   default action;
}

È possibile scrivere istruzioni switch come segue:

switch (condition) {
   case 1:
      action1;
      break;
   
   case 2:
      action2;
      break;
         
   default:
      defaultaction;
      break;
}

  • Function Calls- Le funzioni dovrebbero essere chiamate senza spazi tra il nome della funzione, la parentesi di apertura e il primo parametro; spazi tra virgole e ogni parametro e nessuno spazio tra l'ultimo parametro, la parentesi di chiusura e il punto e virgola. Ecco un esempio:

$var = foo($bar, $baz, $quux);

  • Function Definitions - Le dichiarazioni di funzione seguono lo "stile BSD / Allman" -

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

  • Comments- I commenti in stile C (/ * * /) e i commenti standard C ++ (//) vanno entrambi bene. L'uso dei commenti in stile Perl / shell (#) è sconsigliato.

  • PHP Code Tags- Usa sempre <? Php?> Per delimitare il codice PHP, non il <? ?> stenografia. Ciò è necessario per la conformità a PHP ed è anche il modo più portatile per includere il codice PHP su diversi sistemi operativi e configurazioni.

  • Variable Names -

    • Usa tutte le lettere minuscole
    • Usa "_" come separatore di parole.
    • Le variabili globali dovrebbero essere precedute da una "g".
    • Le costanti globali dovrebbero essere tutte maiuscole con separatori "_".
    • Le variabili statiche possono essere precedute da "s".

  • Make Functions Reentrant - Le funzioni non dovrebbero mantenere variabili statiche che impediscono a una funzione di essere rientrante.

  • Alignment of Declaration Blocks - Il blocco delle dichiarazioni dovrebbe essere allineato.

  • One Statement Per Line - Dovrebbe esserci una sola istruzione per riga a meno che le istruzioni non siano strettamente correlate.

  • Short Methods or Functions - I metodi dovrebbero limitarsi a una singola pagina di codice.

Potrebbero esserci molti altri punti che dovrebbero essere considerati durante la scrittura del programma PHP. L'intenzione principale dovrebbe essere quella di essere coerenti durante tutta la programmazione del codice e sarà possibile solo quando seguirai uno standard di codifica. Puoi dispositivo il tuo standard se ti piace qualcosa di diverso.