Un documento sugli standard di codifica è utile. È molto utile quando è abbastanza corto da consentire a chiunque di ricordare tutto senza troppi problemi e quando non causa troppo dolore a nessuno.
Il modo in cui scegli di indentare il codice nella tua organizzazione, di scrivere in maiuscolo i nomi, di implementare i tuoi loop o di commentare il tuo codice non è poi così importante; la parte utile è far scrivere a tutti un codice simile a quello di tutti gli altri.
- Evita di dover dedicare un minuto a ricalibrare le tue aspettative su dove dovrebbero essere le parentesi graffe e così ogni volta che guardi il codice di qualcun altro.
- Evita di avere diversi stili di codice nello stesso file.
- Forse ancora più importante, avere uno standard scritto evita argomenti sulle pratiche di codifica durante le revisioni del codice.
Ancora una volta, quali sono gli standard non importa tanto quanto avere una sorta di standard semplice e diretto. Quindi, metti tutti i tuoi sviluppatori in una stanza e lascia che discutano su quali dovrebbero essere gli standard. Questo incontro potrebbe durare indefinitamente, quindi le regole sono:
- Tutto ciò che non viene deciso entro la fine della riunione sarà deciso dal gestore.
- L'incontro terminerà dopo due ore, o quando qualcuno inizia a urlare o piangere, a seconda di quale evento si verifichi per primo.
- L'intero standard si adatterà (di dimensioni ragionevoli!) Su un foglio o due di carta, fronte-retro solo se assolutamente necessario.
Valuta di adottare qualcuno | di | gli standard come punto di partenza per il proprio incontro sugli standard di codifica o come modo per evitare del tutto l'incontro.
Una volta concordato, gli sviluppatori dovrebbero essere in grado (e ci si dovrebbe aspettare che) poliziotti da soli. La deviazione occasionale dallo standard non dovrebbe essere un grosso problema (e potrebbe anche essere giustificabile), ma il rifiuto sprezzante di abbandonare uno stile personale preferito a favore dello standard dovrebbe comportare il trasferimento immediato in ufficio con le tubature dell'acqua che perdono, o qualsiasi altra cosa .
Demian Brecht indica strumenti per pelucchi. Questi sono un complemento perfetto per un documento sugli standard di codifica. È semplicemente buono attenersi agli standard di stile di codifica ; è importante attenersi agli standard di codifica relativi a pratiche pericolose. Nessun altro a parte l'autore verificherà che ogni riga di codice soddisfi lo standard di stile, ma dovresti certamente considerare la possibilità di creare uno strumento lanugine nel flusso di lavoro del tuo team per rilevare automaticamente i possibili bug. Inoltre, lo strumento stesso può codificare le pratiche accettate in modo da non doverle elencare tutte individualmente negli standard di codifica; basta specificare la configurazione dello strumento.
Nota: l'idea di "standard di codifica" non è esclusiva della programmazione. Gli "standard di codifica" sono utilizzati in molti campi, a volte all'interno di un'organizzazione, più spesso in un intero settore o professione. Qualche esempio:
In ogni caso (e molti altri) un professionista competente può facilmente comprendere "codice" che non soddisfa lo standard previsto. Perché così tante industrie continuano a scrivere requisiti dettagliati per i documenti che non hanno nemmeno bisogno di essere analizzati da un compilatore? Perché lo stile conta . La presentazione di informazioni in uno stile standard consente al lettore di concentrarsi interamente sul contenuto, rende più veloce la lettura e aiuta la comprensione e riduce gli errori.