Zend Framework e buone pratiche di scrittura del codice

Lo standard di Zend Framework per la scrittura del codice pone l'accento sulla leggibilità e sulla facilità di gestione del codice. Fornendo uno standard per la scrittura del codice si riducono notevolmente le possibilità di errori e fraintendimenti specialmente quando si lavora in team. Vediamo di seguito queste convenzioni, ricordando che il documento di riferimento può essere rintracciato all'indirizzo http://framework.zend.com/manual/en/coding-standard.html.

Nomenclatura

  1. Usate nomi di classi che corrispondano alla struttura della directory in cui la classe risiede aggiungendo al nome della classe un prefisso con il nome della directory seguito da un underscore. Per esempio, se tutte le vostre classi si trovano nella directory Test, allora una classe può chiamarsi Test_MiaClasse.

  2. Usate lettere maiuscole solo per la prima lettera di ciascuna parola nei nomi di file e directory.

  3. Usate nomi descrittivi per i metodi e le proprietà nei limiti della massima praticità possibile utilizzando la notazione camel case.

  4. Utilizzate un underscore all'inizio dei nomi delle proprietà di tipo protected e private.

  5. Usate i caratteri maiuscoli solo per le costanti e separate ogni parola con un underscore.

Stile del codice

  1. Usate sempre la notazione estesa per i tag di apertura PHP (<?php).

  2. Omettete il tag PHP di chiusura nei file che contengono solo codice PHP. Questo ci permette di evitare lo spazio in eccesso che potrebbe causare errori con gli include.

  3. Indentate il codice di 4 spazi.

  4. Ove possibile, usate righe di al massimo 80 caratteri.

  5. Usate sempre virgolette singole per le stringhe, a meno che queste non contengano variabili da elaborare o altre virgolette.

  6. Usate una combinazione di virgolette singole e doppie nell'escape delle virgolette.

  7. Inserite uno spazio prima e dopo un operatore di concatenazione (.) per aumentare la leggibilità.

  8. Inserite uno spazio dopo le virgole per aumentare la leggibilità.

  9. Dividete gli array associativi su più righe e usate gli spazi per allineare chiavi e valori.

  10. Le parentesi di apertura e chiusura di classi e funzioni vanno su due righe separate.

  11. La parentesi di apertura di un blocco condizionale va sulla stessa riga della condizione, ma la parentesi di chiusura deve andare su una riga a parte.

  12. Usate i commenti PHPDoc.

Torna su