Gli standard di codifica di WordPress indentazione, utilizzo dello spazio e spazi finali

L'intero scopo di questa serie per aiutare a esporre gli standard di codifica di WordPress, perché sono importanti e come scrivere codice WordPress di qualità. Per fare questo, stiamo dando un'occhiata approfondita a ciascuna sezione degli standard di codifica di WordPress.

Finora, abbiamo coperto:

  • Convenzioni di denominazione e argomenti di funzione
  • Virgolette singole e virgolette doppie

Oggi copriremo l'importanza dello spazio bianco. Nello specifico, copriremo indentazione, utilizzo dello spazio e spazi finali. Per quanto facile possa sembrare, questi sono alcuni degli aspetti più ignorati o abusati degli standard di codifica.


Una parola su Whitespace

Prima di esaminare cosa succede con i vari standard di codifica, è importante capire perché lo spazio bianco è importante non solo in WordPress, ma in linguaggi di programmazione in generale.

In poche parole, è perché migliora la leggibilità.

Questo è il motivo per cui alcuni linguaggi di programmazione sono spazi o delimitati da tabulazioni, ecco perché alcuni linguaggi di programmazione richiedono di distanziare alcune parti del codice come parametri di funzione, indici di array e altro.

Quando si tratta di WordPress, le convenzioni sono in atto non solo per la leggibilità, ma anche per fornire un'esperienza di lettura e sviluppo coerente per tutti coloro che lavorano su temi WordPress, plugin, applicazioni o l'applicazione principale stessa.

Ricorda: Lo scopo degli standard di codifica è di far sì che il codice sorgente appaia come se fosse stato scritto da un singolo sviluppatore, in quanto stabilisce un livello di aspettative per gli sviluppatori che contribuiscono.


dentellatura

Per quanto riguarda l'indentazione, non c'è nulla di particolarmente nuovo, rivoluzionario o diverso in relazione a WordPress. In generale, indenterai ogni volta che inizi un nuovo blocco.

Ciò significa che:

  • Le tue funzioni saranno rientrate all'interno della classe
  • I tuoi condizionali e interruttore / casi e altri blocchi saranno rientrati nelle loro funzioni
  • I tuoi loop saranno rientrati all'interno delle loro funzioni, all'interno dei loro condizionali e così via

Se sei abituato a scrivere codice in lingue in stile C, non c'è nulla di particolarmente nuovo qui, giusto?

Un esempio di come potrebbe essere questo è esattamente questo:

 function foo ($ arguments) if (0 < count( $arguments )  foreach ( $arguments as $arg => valore $) echo $ valore; 

Secondo gli standard di codifica:

La tua indentazione dovrebbe sempre riflettere la struttura logica. Uso schede reali e non spazi, in quanto ciò consente la massima flessibilità tra i clienti.

Le chiavi sono che l'inizio delle linee dovrebbe iniziare con le schede e che il codice dovrebbe riflettere a logico struttura. Non complicare eccessivamente o cercare di semplificare eccessivamente le cose.

C'è un'altra sfumatura nello spazio bianco all'interno degli standard di codifica di WordPress: le schede dovrebbero essere usate all'inizio della riga, ma gli spazi dovrebbero essere usati ovunque. Per la maggior parte, questa è una regola facile da seguire; tuttavia, in WordPress, creerai spesso matrici da passare come argomenti.

Idealmente, desideriamo che ogni indice dell'array sia allineato in modo che la leggibilità sia il più elevata possibile, ma spesso abbiamo la propensione a utilizzare le schede per semplificare l'allineamento, ma questa è in realtà una violazione degli standard di codifica.

 $ args = array ('ID' => 1, 'post_title' => 'Il titolo', 'post_content' => 'Il contenuto');

Come tale, assicurati di te solo utilizzare le schede all'inizio di ogni riga.


Utilizzo dello spazio

Per quanto riguarda WordPress, ho scoperto che gli spazi sono stati usati molto più liberamente che in altre lingue. Non sto dicendo questo semplicemente come un'osservazione, in quanto era un adattamento personale che dovevo apportare sia da .NET che da Ruby.

Detto questo, come per la maggior parte delle altre linee guida del Codice, non c'è nulla di particolarmente complesso; tuttavia, ci sono alcune importanti distinzioni che devono essere ricordate durante la scrittura del codice.

Gli spazi devono essere collocati nei seguenti luoghi:

  • Dopo le virgole
  • Da entrambi i lati degli operatori logici (cioè, ||, &&, e !)
  • Da entrambi i lati degli operatori di confronto (ovvero, <, >, ==, ===, eccetera.)
  • Su entrambi i lati degli operatori incaricati (vale a dire =)
  • Su entrambi i lati della parentesi aperta e chiusa di funzioni, condizionali, cicli e così via.
  • Quando una variabile viene passata come indice di un array, ma non quando un valore letterale (come una stringa o un intero)

La maggior parte di questi sono relativamente semplici, ma nella mia esperienza ho scoperto che le regole dell'array tendono a causare la maggior confusione tra gli sviluppatori, quindi ecco una breve nota di ciò che è considerato corretto e cosa non lo è:

 // Correggere la spaziatura ... $ arr [$ x] = 'pippo'; $ arr [0] = 'bar'; // Spaziatura errata ... $ arr [$ x] = 'bar'; $ arr [0] = 'bar';

Come puoi vedere, non è niente di particolarmente complicato, ma è una convenzione relativamente facile da perdere.


Trailing Spaces

Questa regola è probabilmente lo standard più semplice da ricordare di tutti. In parole povere, non dovrebbero esserci spazi finali alla fine di alcuna riga di codice.

A seconda dell'IDE, è possibile che questo filtro sia integrato; altre volte, potrebbe essere necessario installare un plug-in che eseguirà questa azione per te ogni volta che salvi il file. Ma in ogni caso, è una caratteristica relativamente facile da integrare in qualsiasi IDE si sta utilizzando.

Inoltre, la maggior parte degli editori - indipendentemente dal fatto che si tratti di un editor di testo glorificato o di un IDE completo - è necessario avere la possibilità di abilitare la visualizzazione di schede e spazi.

Visualizzazione di schede e spazi bianchi in Coda 2

Ancora una volta, questa è una delle convenzioni più semplici da seguire ed è probabile che il tuo IDE o editor di scelta abbia questa funzionalità o un plugin disponibile che ti consenta di farlo automaticamente.

In caso contrario, dovresti essere in grado di attivare la possibilità di visualizzare schede, spazi, ritorni a capo e così via in modo da poter identificare facilmente dove gli spazi finali sono.


Conclusione

Ovviamente, lo spazio bianco svolge un ruolo significativo nella scrittura del codice basato su WordPress. In questo articolo abbiamo esplorato indentazione, tabulazioni, spazi, spazi finali e perché e come incorporarli nei nostri progetti.

Nel prossimo articolo, continueremo a parlare delle sottigliezze degli standard di codifica di WordPress osservando lo stile rinforzato, le espressioni regolari e le sfumature dell'utilizzo di tag PHP attraverso il nostro codice WordPress.