Buon codice contro cattivo codice: perché è importante scrivere un buon codice e come farlo

Quando si scrive codice in qualsiasi lingua, ci sono buone pratiche di codifica - e ce ne sono di cattive.

Entrambi possono essere corretti per quanto riguarda la compilazione e quando vengono eseguiti. Ma il codice errato può presentare alcuni problemi nello sviluppo, nel debug e nella modifica. Sul posto di lavoro, indipendentemente dalla corretta esecuzione del programma, a un certo punto qualcuno dovrà leggere e / o modificare il codice.

Potrebbero dover aggiungere nuove funzionalità, correggere un bug raro o potrebbero semplicemente volerlo leggere per capire come funziona. Allo stesso modo, dovrai leggere il codice di qualcun altro per fare la stessa cosa. Tutti andranno molto d'accordo se il codice è leggibile e comprensibile.

Per conoscere l'importanza di un codice di buona qualità, proviamo a capire a cosa può portare una cattiva qualità del codice. Un codice scritto in modo errato potrebbe comportare perdite finanziarie o perdite di tempo necessarie per ulteriore manutenzione, miglioramenti o adeguamenti di un software.

Scrivi il tuo codice una volta, ma poi lo segui numerose volte dopo. Quindi, documentare il tuo codice diventa davvero importante e le convenzioni di denominazione diventano davvero importanti.

Molte volte mi capita di incontrare i miei colleghi scherzando su come non ricordano quale codice o logica hanno scritto qualche giorno fa. Ora abbinalo con la scrittura di uno stile di codice errato e avrai più tempo per capire cosa hai fatto. Le cose iniziano ad andare in tilt quando un artista non riesce a capire la propria opera d'arte

Punti chiave da tenere a mente durante la scrittura del codice

// Commenti in soccorso

La maggior parte delle lingue moderne ha commenti dichiarativi documentati e il loro uso in combinazione con commenti a riga singola e multipla rende il codice più comprensibile e quindi mantenibile.

I buoni commenti in codice spiegano perché le cose vengono fatte, non ciò che viene fatto. Il codice stesso spiega cosa viene fatto. La necessità di commenti dovrebbe essere minima.

dentellatura

Il buon codice è strutturato correttamente come mostrato in figura. Dovrebbe essere ovvio per la persona che cerca di capire il codice dove inizia un blocco di codice e dove finisce, in modo che seguire la logica della base di codice diventi evidente e diretto.

Rientro: rientro normale dello spazio di norma 4

Readme di

È fastidioso quando hai una base di codice di un progetto di fronte a te, ma l'installazione e la prima esecuzione richiedono ore per farti girare. Questo è dove readme è utile.

È sempre meglio avere una breve introduzione a un progetto prima di accedere al codice e un file Leggimi adeguatamente strutturato fa esattamente questo. Un file Leggimi correttamente strutturato è simile al seguente:

Convenzioni di denominazione

Molte volte ci imbattiamo in una classe con il nome Apimanager, ma guardando il nome, lo scopo della classe non è chiaro.

Secondo le norme sulle migliori pratiche di codifica, le nostre classi dovrebbero seguire il principio della responsabilità singola (SRP). Convenzioni di denominazione appropriate abbinate a SRP rendono le nostre vite molto più facili mentre proviamo a seguire un progetto.

Le convenzioni di denominazione dovrebbero anche variare per scopi diversi se una Classe sta eseguendo alcune unità di lavoro intensivo. Questo al fine di differenziare quando e dove una variabile diventa fuori campo solo guardando il blocco di codice.

Usa convenzioni di denominazione significative per tutti tranne gli oggetti più transitori. Il nome di qualcosa è informativo su quando e come usare l'oggetto.

Evita i numeri magici

Cos'è un numero magico? È una costante, completamente priva di documenti, che deve essere un valore particolare per il corretto funzionamento del programma. Nessuno sa perché sia ​​stato scelto quel numero.

Nella sua forma più magica, nessuno sa davvero come il numero influisca sul programma ... a parte il fatto che cambiarlo si rompe le cose.

I numeri magici sono malvagi e dovrebbero essere aboliti a vista.

Adattandosi ai tempi

L'immagine sotto parla da sola.

Codice di qualità alle scadenze

Pratiche comuni per la scrittura di codice pulito e di buona qualità

Passaggi ampiamente utilizzati per migliorare la qualità del codice

Scrivere un codice di buona qualità è un processo dinamico. Alcuni altri punti da considerare durante il tentativo di scrivere "buon codice":

  • Il buon codice è ben organizzato. Dati e operazioni nelle classi si incastrano. Non ci sono dipendenze estranee tra le classi. Non sembra "spaghetti".
  • Il buon codice è ben testato. I test servono come specifica eseguibile del codice ed esempi del suo utilizzo.
  • Il buon codice non è "intelligente". Fa le cose in modo semplice, ovvio.
  • Il buon codice è sviluppato in unità di calcolo piccole e di facile lettura. Queste unità vengono riutilizzate in tutto il codice.

Grazie per la lettura, ti preghiamo di condividerlo se lo hai trovato utile :)