Scrivere codice riciclabile

La stragrande maggioranza del codice che scriviamo ha lo scopo di servire a un unico scopo e una volta impiegato in quello scopo non vede mai più la luce del giorno. Questo è, comunque, un po 'uno spreco del tuo tempo prezioso, quando è perfettamente possibile scrivere il tuo codice in modo tale che possa essere riciclato e messo in uso in molti scopi diversi.

La sfida è che scrivere codice riciclabile è abbastanza diverso da scrivere quello che potrebbe essere definito come codice "throw-away". Con quest'ultimo tipo di codice, devi solo preoccuparti di come gli altri umani interpretano le istruzioni del codice se non hai scritto perfettamente queste istruzioni. Quando scrivi codice riciclabile, tuttavia, devi farlo in un modo molto specifico, e devi davvero pensare a come qualcuno, incluso te stesso, capirà il codice che hai scritto in futuro.

Fare cose in questo modo richiede molto più tempo e impegno rispetto alla normale codifica, tuttavia ha il vantaggio di non dover mai scrivere la stessa identica funzione due volte. Come già detto, dovrai fare tutto in un certo modo per essere sicuro che il tuo codice possa davvero essere riutilizzato per altri scopi.

Vale la pena ricordare che il codice riciclabile non è necessariamente la stessa cosa di un plug-in. Quando crei un plug-in, stai sviluppando del codice che chiunque può prendere e incorporare nel proprio sito Web e generare facilmente alcuni effetti semplicemente modificando alcuni parametri.

Il codice riciclabile è diverso nel senso che non è necessariamente statico e non è necessariamente destinato alla distribuzione al di fuori della propria organizzazione. Indipendentemente da cosa, è essenziale assicurarsi di utilizzare la procedura corretta, descritta di seguito.

1. Diventa un maestro di organizzazione

Quando crei il codice con l'intenzione di riutilizzarlo in un secondo momento, ciò non ti aiuterà molto se non riesci a trovarlo. È necessario fare un ottimo lavoro di denominazione, memorizzazione e classificazione dei file di codice.

2. Sii consapevole di cosa è "specifico dell'applicazione" e cosa è "generico"

Quasi sempre ci sarà del codice che è veramente specifico per la tua particolare applicazione e non potrebbe essere usato in nessun altro modo. Mentre crei ogni blocco di codice, dovresti decidere se si tratta di codice specifico dell'applicazione o generico. In definitiva, si desidera creare molto più di quest'ultimo rispetto al primo, e c'è un buon modo per farlo che descriverò nel passaggio 3.

3. Codice separato da valori

I valori delle variabili codificati possono presentare un problema quando si desidera utilizzare il codice in modi nuovi. Un modo migliore per farlo è quello di memorizzare i valori delle variabili iniziali in qualcosa di simile a un file CSV, e quindi caricare quei valori quando inizia l'applicazione. Questo metodo consente inoltre di modificare facilmente i valori delle variabili iniziali senza alterare il file di codice originale.

4. Cerca di non codificare a macchina valori che non devono assolutamente essere

Questo in pratica significa che non dovresti codificare affatto alcun valore, con un'eccezione che è il nome del file che verrà caricato contenente tutti i valori codificati. Quel file dovrebbe essere sempre accessibile rispetto al percorso root dell'applicazione, oppure si potrebbero avere problemi se si spostano i file su un sistema operativo diverso.

5. Evita di inserire spazi nei nomi dei file

Solo perché puoi inserire spazi nei nomi dei file non significa che dovresti. Può potenzialmente creare problemi se si spostano i file su un sistema operativo o un file system diverso. Ad esempio, se sposti i file da ext4 a FAT, potresti riscontrare dei problemi. È interessante notare che il sistema operativo Windows mostrerà i nomi dei file con caratteri non validi al loro interno, ma non ti permetterà alcun accesso a quei file, anche se tutto ciò che vuoi fare è rinominarli.

5. Commenta tutto in modo verbale

Nel momento in cui scrivi il tuo codice, sai esattamente cosa sta per fare. Ma lascia passare qualche anno ed è possibile che tu abbia dimenticato le tue intenzioni. È la stessa storia anche quando usi il codice di qualcun altro, perché, a meno che non abbiano fornito commenti dettagliati, dovrai trascorrere momenti preziosi analizzando e interpretando ciò che hanno scritto.

6. Evita di creare dipendenze

Uno dei più grandi difetti nella maggior parte degli scenari di codice riutilizzabili è che si può finire con enormi catene di dipendenze dei file. Ciò accade perché le persone scrivono i loro blocchi di codice in modi specifici e li includono in un ordine specifico senza documentare il perché. Poi, prima che tu te ne accorga, finisci con uno scenario Left-Pad e tutti si lasciano prendere dal panico quando qualche chunk di codice a cui la tua applicazione dipende dipende da AWOL.

Puoi evitare questo tipo di fusione assicurandoti che ogni pezzo di codice possa essere facilmente sostituito con un altro, documentandolo come un matto, e ovviamente facendo copie di backup di ogni pezzo.

La documentazione deve comprendere che cos'è un file, cosa fa e perché è caricato nella posizione particolare in cui è caricato. Ciò elimina potenziali problemi di dipendenza, poiché ogni porzione di codice può essere ricreata perché il suo scopo è noto.

7. Formatta tutto il tuo codice in modo accurato

Ovviamente è una buona idea farlo sempre comunque, ma è particolarmente importante farlo quando scrivi del codice riusabile. Dovresti anche mantenere uno stile di codifica molto coerente e non cambiarlo. Ad esempio, se tendi a scrivere i tuoi nomi costanti in nomi maiuscoli e variabili in camelCase, dovresti farlo con assoluta coerenza.

8. Ogni pezzo di codice ha uno scopo specifico

La tua missione è capire quale sia lo scopo. Devi evitare di consentire più scopi per blocco. Ad esempio, se hai un pezzo di codice che carica nei valori delle variabili iniziali, non dovrebbe fare altro. Il tuo prossimo pezzo di codice dovrebbe gestire la prossima operazione richiesta. Quanto è severa questa regola? Bene, la tua funzione principale non dovrebbe fare altro che effettuare chiamate a tutte le altre funzioni.

È molto più difficile scrivere buoni buoni riciclabili di quanto chiunque penserebbe prima di tentare. Non importa quali siano le tue intenzioni iniziali, è probabile che scoprirai che circa 80% del codice che scrivi diventerà specifico dell'applicazione piuttosto che generico. La maggior parte delle persone è entusiasta del codice riciclabile senza avere la minima idea di come mai lo utilizzeranno in futuro, con il risultato finale che creano più lavoro per se stessi, il che è l'opposto dell'obiettivo. Speriamo che questo articolo ti abbia aiutato a evitare quel destino.

immagine di cortesia per gentile concessione di DKNG

Bogdan Rancea

Bogdan è membro fondatore di Inspired Mag, avendo accumulato quasi 6 anni di esperienza in questo periodo. Nel tempo libero ama studiare musica classica ed esplorare le arti visive. È piuttosto ossessionato dai fissaggi. Possiede già 5.