Scrivere codice PHP con stile

6 febbraio 2009

Scrivere codice con stile permette di creare listati più leggibili e semplici da modificare così come di correggere più rapidamente le applicazioni o di integrarle con nuove funzionalità; per utilizzare uno stile chiaro in sede di sviluppo è necessario acquisire un metodo, ce ne sono di diversi e non necessariamente uno è da ritenersi migliore dell’altro, è comunque fondamentale individuare quello più adatto per le proprie esigenze in modo da rendere il proprio lavoro più rapido ed eventualmente facilitare il compito di coloro che, per diverse (e lecite) ragioni, dovessero avere accesso al codice di un’applicazione.

Un esempio classico in relazione all’argomento trattato, è quello degli script distribuiti sotto licenza Open Source, non basta che questi siano “liberamente” modificabili, è necessario anche che siano scritti i modo chiaro e che sia possibile individuare facilmente all’interno di essi i diversi elementi compositivi in modo da apportare, senza inutili sforzi, le modifiche del caso.

Scegliere uno stile per i commenti

Un codice ben scritto è anche un codice ben commentato, l’affermazione può sembrare perentoria ma soprattutto quando si deve affrontare la digitazione di listati di grandi dimensioni è bene tenere a mente che non basta trovare i giusti termini da associare alle variabili, non è sufficiente indentare il codice all’apertura di ogni nuova parentesi, bisogna anche utilizzare i commenti in modo razionale; infatti i commenti possono essere utilizzati per numerosi scopi:

  • Introdurre delle note informative (una licenza, un copyright, una procedura d’installazione o un semplice messaggio per sé e per gli utilizzatori etc.)
  • Delimitare un frammento di codice funzionalmente distinto dagli altri
  • Isolare più frammenti di codici che svolgono funzioni simili ma non uguali in modo da non generare confusione
  • Disabilitare un frammento di codice che potrà essere decommentato in caso di necessità (ad esempio: un sistema di paginazione)
  • Inserire annotazioni o avvertimenti (ad esempio: “Non applicare modifiche al di sotto di questa riga!”)
  • Fornire spiegazioni relativamente all’utilizzo di determinati elementi (ad esempio: “Valorizzare le variabili successive con i dati di connessione a MySQL.”)

Come è noto PHP permette di utilizzare tre tipologie di stili per i commenti, ma forse non tutti sanno che questi sono stati mutuati da altri linguaggi:

<?php
# stile shell di Unix (ma anche Perl e Python)

// commento in stile C++

/* commento in stile C, utilizzato anche in Java */
?>

Quale di questi è il migliore quando si sviluppa in PHP? La domanda non può avere una risposta certa in linea generale, l’ultimo stile elencato potrebbe risultare più adatto per lunghi blocchi di commenti così come i primi due stili potrebbero essere preferibili per brevi commenti su singola riga; ma è possibile essere più chiari se la domanda diventa Quale stile utilizzare per i commenti in una determinata applicazione in PHP? La risposta più corretta in questo caso potrebbe essere “Sempre lo stesso stile per indicare gli stessi elementi”.

Se vuoi aggiornamenti su Scrivere codice PHP con stile inserisci la tua e-mail nel box qui sotto:
 
X
Se vuoi aggiornamenti su Scrivere codice PHP con stile

inserisci la tua e-mail nel box qui sotto:

Ho letto e acconsento l'informativa sulla privacy

Acconsento al trattamento di cui al punto 3 dell'informativa sulla privacy