Standardizzazione del codice
En SelfishSiamo consapevoli dell'importanza fondamentale di mantenere standard elevati nella scrittura e nella strutturazione del codice. Questa pagina è dedicata alle nostre linee guida per la standardizzazione del codice, un insieme di regole e pratiche che seguiamo rigorosamente per garantire la qualità, l'efficienza e la manutenibilità dei nostri progetti di sviluppo web.
Qui troverete una guida dettagliata ai nostri metodi e principi per la standardizzazione del codice, pensati non solo per migliorare la coerenza e la prevedibilità del nostro lavoro, ma anche per facilitare la collaborazione e la comprensione tra i membri del nostro team e i nostri clienti.
Queste linee guida sono il risultato di anni di esperienza e apprendimento continuo, riflettono le migliori pratiche del settore e si adattano alle ultime tendenze e tecnologie nello sviluppo software. Che tu sia un membro del nostro team, un collaboratore o semplicemente qualcuno interessato alle migliori pratiche di programmazione, siamo certi che troverai queste informazioni preziose e arricchenti.
Codice leggibile e pulito.
Evitare di mischiare codice con funzioni simili.
Tabulazione a 4 spazi.
CRLF solo a LF.
Uso corretto degli spazi.
Parametri di output all'inizio.
Codice inglese.
Sebbene la pagina possa essere in diverse lingue, come prassi standard sarebbe corretto che la nostra programmazione fosse realizzata in inglese.
Variabili autodescrittive.
Una variabile dovrebbe essere comprensibile fin dal suo nome, tenendo presente che dovrebbe essere il più breve possibile.
Dividi e conquista
Eseguire funzioni e codice atomico per attività ripetitive.
L'implementazione delle funzioni aiuta a mantenere il programma con la minima quantità di codice ripetuto e a granularizzare le funzioni per una manutenzione più semplice.
Operatori ternari quando appropriato
Incoraggiare l'uso corretto degli operatori ternari quando non influiscono sulla leggibilità del codice.
Notazione
Per convenzione e preferenza dell'utente, la notazione da utilizzare sarà "Snake Case"
Ad eccezione della gestione delle classi, in quanto adatta al linguaggio di programmazione utilizzato, dove nella maggior parte dei casi le classi sono denominate con CamelCase
Booleani con il prefisso (is)
Seguendo la logica della programmazione in inglese e secondo gli standard, la cosa corretta da fare è usare il prefisso "is" quando si dichiara una variabile booleana o quando si crea una funzione il cui scopo è restituire una risposta simile.
Documentazione e separazione del codice adeguate
Sarà necessario fornire commenti di base sul funzionamento del codice, nonché indizi che aiutino a descrivere le variabili e a individuare facilmente la parte del codice in cui si trova.
Confronto esplicito
Come metodo di prevenzione degli errori, l'approccio corretto è quello di utilizzare confronti espliciti all'interno delle strutture di controllo.
Validazione delle stringhe vuote
Come metodo di prevenzione dei rischi, la cosa giusta da fare è utilizzare gli strumenti che il linguaggio può fornirci.
Evitare variabili non necessarie
Sia in PHP che in Javascript, il codice può essere reso più efficiente evitando la creazione di variabili non necessarie.
Evitare l'uso multiplo di query e accessi DOM.
Oltre al punto precedente, quando è necessario eseguire più query in qualsiasi linguaggio, la cosa corretta da fare è eseguire la query una sola volta e utilizzare una variabile.
Gestione delle eccezioni
L'uso corretto delle eccezioni supporta la gestione degli errori senza compromettere la funzionalità del codice.
Utilizzo di jQuery.
Per convenzione, la raccomandazione sarà di utilizzare jQuery come metodo per accedere al DOM quando necessario.
Evitare le query al database.
Per convenzione, la raccomandazione sarà di utilizzare jQuery come metodo per accedere al DOM quando necessario.
Evitare le query al database.
WordPress offre un gran numero di funzioni di query sui dati, pertanto, se possibile, è opportuno evitare le query dirette al database.
Evitare componenti dipendenti da terze parti.
Per evitare dipendenze da funzioni di terze parti, quando possibile l'approccio corretto è quello di provare a ottenere il codice da utilizzare e aggiungerlo a WordPress.
Metodo KISS.
KISS è l'acronimo di Keep It Simply Stupid. Un codice semplice e facile da capire è molto più facile da mantenere nel lungo periodo, quindi a volte vale la pena sacrificare un po' di prestazioni per garantire che il codice aderisca a questo principio.
Utilizzare un IDE standard.
Per obblighi contrattuali, quando si lavora su progetti esterni a WordPress verrà utilizzato lo stesso IDE. Verrà utilizzato VS Code.
Implementare il software di controllo delle versioni.
Git verrà implementato come software di controllo delle versioni.