Recyclebare code schrijven

De overgrote meerderheid van de code die we schrijven is bedoeld om een ​​enkel doel te dienen en eenmaal gebruikt in dat doel ziet het nooit het levenslicht. Dat is echter een beetje verspilling van uw kostbare tijd, wanneer het perfect mogelijk is om uw code zodanig te schrijven dat deze voor veel verschillende doeleinden kan worden gerecycled en gebruikt.

De uitdaging is dat het schrijven van recyclebare code behoorlijk verschilt van het schrijven van wat kan worden genoemd als "wegwerp" -code. Met de laatste soort code, hoef je je alleen maar zorgen te maken over hoe andere mensen je code-instructies interpreteren als je die instructies niet perfect hebt geschreven. Wanneer u recyclebare code schrijft, moet u dit echter op een heel specifieke manier doen, en u moet er echt over nadenken hoe iemand, inclusief uzelf, de code die u op een bepaald moment in de toekomst hebt geschreven, zal begrijpen.

Dingen doen op deze manier kost veel meer tijd en moeite dan gewone codering, maar het heeft het voordeel dat je nooit exact dezelfde functie twee keer hoeft te schrijven. Zoals gezegd, moet u alles op een bepaalde manier doen om er zeker van te zijn dat uw code ook daadwerkelijk voor andere doeleinden kan worden gebruikt.

Het is de moeite waard te vermelden dat recycleerbare code niet noodzakelijkerwijs hetzelfde is als een plug-in. Wanneer u een invoegtoepassing maakt, ontwikkelt u een code die iedereen kan opnemen en opnemen in hun website en eenvoudig een bepaald effect kan genereren door slechts een paar parameters te wijzigen.

Recyclebare code is anders in de zin dat het niet noodzakelijk statisch is en niet noodzakelijkerwijs bedoeld is voor distributie buiten uw eigen organisatie. Wat er ook gebeurt, het is essentieel om ervoor te zorgen dat u het juiste proces gebruikt, dat hieronder wordt beschreven.

1. Word een meester in de organisatie

Wanneer u code maakt met de bedoeling dat u deze later opnieuw kunt gebruiken, zal dat u niet veel helpen als u het niet kunt vinden. U moet uw codebestanden heel goed benoemen, opslaan en classificeren.

2. Wees je bewust van wat "toepassingsspecifiek" is en wat "generiek" is

Bijna altijd zal er een code zijn die echt specifiek is voor uw specifieke toepassing en deze kan niet op een andere manier worden gebruikt. Terwijl u elk stuk code maakt, moet u beslissen of het toepassingsspecifieke of generieke code is. Uiteindelijk wil je veel meer van het laatste maken dan het eerste, en er is een goede manier om dit te doen dat ik in stap 3 ga beschrijven.

3. Aparte code van waarden

Variabele waarden met harde codering kunnen een probleem vormen wanneer u code op nieuwe manieren wilt gebruiken. Een betere manier om dit te doen, is door uw initiële variabelewaarden op te slaan in zoiets als een CSV-bestand en deze waarden vervolgens in te laden wanneer de toepassing start. Met deze methode kunt u eenvoudig de beginvariabele-waarden wijzigen zonder te knoeien met uw originele codebestand.

4. Probeer geen waarden te coderen die niet absoluut moeten zijn

Dit betekent in feite dat je helemaal geen waarden hoeft te coderen, met één uitzondering: de naam van het bestand dat wordt geladen met alle soft-coded waarden. Dat bestand moet altijd toegankelijk zijn ten opzichte van het rootpad van de toepassing, anders kunt u problemen ondervinden als u de bestanden naar een ander besturingssysteem verplaatst.

5. Plaats geen spaties in bestandsnamen

Alleen omdat je spaties in bestandsnamen kunt plaatsen, betekent nog niet dat je dat zou moeten doen. Het kan mogelijk problemen voor u veroorzaken als u uw bestanden naar een ander besturingssysteem of bestandssysteem verplaatst. Als u bijvoorbeeld uw bestanden van ext4 naar FAT verplaatst, zou u kunnen merken dat u problemen tegenkomt. Interessant is dat het Windows-besturingssysteem de namen weergeeft van bestanden met illegale tekens erin, maar u geen toegang tot die bestanden geeft, zelfs als u alleen maar de naam ervan wilt wijzigen.

5. Reageer alles verbaal

Op het moment dat u uw code schrijft, weet u precies wat het gaat doen. Maar pas een paar jaar toe en het is goed mogelijk dat u uw bedoelingen bent vergeten. Het is hetzelfde verhaal ook wanneer je de code van iemand anders gebruikt, want tenzij ze uitgebreide opmerkingen hebben gegeven, zul je kostbare momenten moeten besteden aan het analyseren en interpreteren van wat ze hebben geschreven.

6. Vermijd afhankelijkheden

Een van de grootste tekortkomingen in de meeste herbruikbare codescenario's is dat u terecht kunt komen met enorme ketens van bestandsafhankelijkheden. Dit gebeurt omdat mensen hun codebrokken op specifieke manieren schrijven en deze opnemen in een specifieke volgorde zonder te documenteren waarom. Dan voordat je het weet, eindig je met een Left-Pad scenario en iedereen in paniek wanneer een stuk van de code waar je applicatie van afhankelijk is, om een ​​of andere reden AWOL gaat.

Je kunt dit soort meltdown voorkomen door ervoor te zorgen dat elk stuk code gemakkelijk kan worden omgewisseld voor een ander, documenteerbaar als een gek en natuurlijk het maken van kopieën van elk deel.

Documentatie moet bevatten wat een bestand is, wat het doet en waarom het wordt geladen op de plaats waar het is geladen. Dit elimineert potentiële afhankelijkheidsproblemen, omdat elk deel van de code opnieuw kan worden gemaakt omdat het doel bekend is.

7. Formatteer al je code heel netjes

Uiteraard is het een goed idee om dit altijd te doen, maar het is vooral belangrijk om dit te doen wanneer je herbruikbare code schrijft. U moet ook een zeer consistente codeerstijl behouden en deze niet wijzigen. Als u bijvoorbeeld de neiging heeft om uw constante namen in hoofdletters en variabelenamen in camelCase te schrijven, moet u dat doen met absolute consistentie.

8. Elk stuk code heeft een specifiek doel

Jouw missie is om te begrijpen wat dat doel is. Je moet voorkomen dat je meerdere doelen per stuk toestaat. Dus als u bijvoorbeeld een stuk code heeft dat in de initiële variabelewaarden wordt geladen, zou het verder niets anders moeten doen. Uw volgende stuk code moet de volgende vereiste bewerking uitvoeren. Hoe streng is deze regel? Nou, je hoofdfunctie zou niets anders moeten doen dan oproepen doen naar alle andere functies.

Het is veel moeilijker om goed recyclebaar goed te schrijven dan iemand zou denken voordat ze het proberen. Het maakt niet uit wat uw oorspronkelijke intenties zijn, u zult waarschijnlijk merken dat over 80% van de code die u schrijft uiteindelijk toepassingsspecifiek zal zijn in plaats van generiek. De meeste mensen zijn dol op recycleerbare code zonder echt een idee te hebben hoe ze deze ooit in de toekomst zullen gebruiken, met als eindresultaat dat ze meer werk voor zichzelf creëren, wat het tegenovergestelde is van het doel. Hopelijk heeft dit artikel je geholpen om dat lot te vermijden.

header afbeelding met dank aan DKNG

Bogdan Rancea

Bogdan is een van de oprichters van Inspired Mag en heeft in die periode bijna 6 jarenlange ervaring opgebouwd. In zijn vrije tijd studeert hij graag klassieke muziek en onderzoekt hij beeldende kunst. Hij is ook behoorlijk geobsedeerd door fixies. Hij is al eigenaar van 5.