Share
In questo sito, passiamo molto tempo a condividere informazioni ea discutere su come realizzare determinate cose con WordPress. Dopo tutto, lo scopo del sito è per fornire tutorial - cioè, cerchiamo di dare consigli pratici su come costruire determinate cose usando la piattaforma.
Ma lo sviluppo non è strettamente relativo alla scrittura di codice e alla costruzione di cose. Riguarda anche la scrittura di qualità, il codice gestibile, il refactoring e il miglioramento dello stato dei nostri progetti e, in generale, il tentativo di lasciare un codebase in uno stato migliore rispetto a quando lo abbiamo trovato (o quando abbiamo iniziato a crearlo).
Quindi, piuttosto che concentrarsi su come costruire qualcosa o rivedere qualsiasi codice particolare, passiamo in rassegna alcuni suggerimenti pratici per la scrittura di codice WordPress di qualità.
Prima di tutto - e anche se discutiamo molto - vale la pena ripeterlo:
Seguire gli standard di codifica di WordPress è una delle cose più importanti che puoi fare quando scrivi temi, plug-in o applicazioni.
Per coloro che non hanno familiarità, gli standard di codifica di WordPress forniscono regole su come dovremmo formattare il nostro PHP basato su WordPress. Certo, non c'è nulla in realtà imporre le regole - puoi ignorarle (e molti lo fanno), ma è considerata una buona pratica per coloro che sono seriamente impegnati nello sviluppo di progetti basati su WordPress, ed è rispettata da coloro che sono attivi nella comunità.
Inoltre, seguire gli standard di codifica significa che noi, insieme a tutti gli altri sviluppatori che lo fanno anche loro, avremo un codice simile. In effetti, uno degli obiettivi degli standard di codifica definiti è che il codice sembra essere stato scritto da un singolo sviluppatore.
Un altro vantaggio è che rende anche facile per gli altri contribuire alla nostra base di codice. Dopotutto, dal momento che WordPress e le sue opere derivative sono open source, altri potrebbero voler venire avanti e dare una mano o contribuire alla fine dando loro la possibilità di leggere facilmente il nostro codice.
Infine, questo non è necessariamente un richiamo all'azione per tornare indietro e refactoring di tutto ciò che hai fatto. Ora è il momento migliore per iniziare a seguire gli standard. I buoni sviluppatori stanno migliorando continuamente, quindi è del tutto accettabile iniziare ora (anche se è nel bel mezzo di un progetto).
Una delle cose più utili che puoi fare quando scrivi codice è di lasciare commenti utili che spiegano esattamente cosa stai tentando di fare.
Naturalmente, i commenti possono vivere a livello di classe, livello di funzione e livello di linea. Sono permessi in PHP, HTML, JavaScript e CSS quindi non ci sono davvero scuse non per includerli da qualche parte.
Certo, scrivere commenti richiede un po 'di tempo in più, ma ricorda che se fosse facile da leggere, non sarebbe chiamato codice.
Pensaci in questo modo: i programmatori sono famosi per tornare ai loro progetti precedenti e riconoscere quanto sia pessimo il loro codice, o come faremmo qualcosa di diverso se stessimo lavorando a quel progetto ora.
Se diciamo questo sul nostro codice, cosa devono pensare gli altri quando vedono il nostro codice, specialmente se provengono da uno sfondo più esperto?
Per ulteriori approfondimenti sul commento sia sul lato server che sul codice lato client, assicurati di rivedere questa serie.
Un'altra cosa che noi sviluppatori possiamo fare è semplificare le nostre funzioni. Anche se mi rendo conto che questo è un po 'un'area soggettiva, penso che puntare a funzioni più piccole e più focalizzate rende il codice più leggibile e può infine aiutare con la testabilità (se sei interessato a seguire quella strada).
Innanzitutto, non è affatto raro vedere funzioni che superano 30, 40 o 50 linee. Il problema è che queste funzioni spesso fanno più di una cosa.
Questo è problematico perché:
Quindi, con ciò detto, ci sono alcuni consigli pratici che possiamo seguire per migliorare la qualità delle nostre funzioni.
Se ti ritrovi a scrivere sempre la stessa cosa tra diverse funzioni, allora è il caso in cui devi estrarre quella particolare parte del codice e spostarla nella sua funzione in modo che possa essere chiamata da tutti i punti che attualmente esiste.
Se ritieni che il tuo codice sia complicato da descrivere con commenti o difficile da tracciare durante la lettura, potrebbe essere utile fare un passo indietro e riformattare il tuo codice in qualcosa di più semplice.
Questo sembra diverso in ogni situazione, ma sforzarsi per la leggibilità rispetto alla complessità è spesso volte un obiettivo migliore da perseguire piuttosto che semplicemente ottenere qualcosa lavorando.
Questo è probabilmente il punto più soggettivo, penso che valga la pena alzare e questo è semplicemente il fatto che dovremmo sforzarci di mantenere le nostre funzioni piccole con 20 linee lunghe essendo una lunghezza relativamente solida per cui puntare. Certo, questo può essere in qualche modo una sfida con il modo in cui WordPress spesso ci richiede di creare array di grandi dimensioni per passare come argomenti, ma ti viene l'idea: mantienili piccoli, focalizzati e mantenibili.
Sì, questo si tradurrà in più funzioni, ma il codice sarà più facile da leggere e conservare poiché ogni funzione ha un singolo scopo specifico. Ciò significa che puoi nominarli con maggiore chiarezza e fornire test unitari attorno a loro più facilmente.
Ovviamente, nessuna delle suddette regole sono dure da seguire: sono semplicemente suggerimenti su come migliorare la qualità del codice che scriviamo, che manteniamo e che contribuiamo al lavoro degli altri.
Soprattutto, credo che dovremmo sforzarci per la leggibilità e la testabilità. Mantenere questi due obiettivi in prima linea nel nostro lavoro aiuterà a portare tutto il resto nel posto giusto.
Certo, questa non è una lista completa - è lontana da ciò! Quindi, per favore, offri i tuoi suggerimenti nei commenti!
Accentsconagua