Oplever block

Verzorging code

Functies en kritieke onderdelen in code (onderdelen die niet in één oogopslag te verklaren zijn) zijn voorzien van comments. Logische structuur in componenten van je project. Variabelen en functies hebben beschrijvende namen. Je bent je bewust van code conventies van de programmeertaal waarin je werkt.

 

Bij het schrijven van code is het noodzakelijk dat het overzichtelijk en duidelijk is voor zowel ik zelf als programmeur maar ook voor iemand waarmee je samen werkt of iemand die je misschien wilt helpen wanneer jij iets niet werkend krijgt dat diegene makkelijk en snel je code begrijpt. Dit doe je door een overzichtelijke structuur aan te brengen in zowel je bestanden als de mappenstructuur. Daarnaast breng je waar nodig comments aan voor bepaalde functies of complexe stukken code. Hieronder heb ik een paar voorbeelden neergezet.

Bij dit project heb ik de namen van de functies van de Typescript bestanden duidelijk met elkaar gecombineerd om zo een goed overzicht te krijgen hoe het samen met elkaar werkt en heb ik ook de elements, id’s en classes van de styling hierop ingesteld.

Naast een duidelijke en overzichtelijke code is het ook belangrijk dat je een goede mappen structuur hebt hierbij is het van belang dat de volgende punten goed naleeft.

  • Alle afbeeldingen in een img map
  • Alle lettertypen in een fonts map
  • Alle styling bestanden in een css map
  • Alle javascript bestanden in een js map
  • Met PHP kan je ook een includes map hebben wanneer je bijvoorbeeld bestanden in andere bestanden wilt toevoegen, dan is het makkelijk om al deze include bestanden bij elkaar te hebben.
  • Ook kan het voorkomen dat er een admin map is om bijvoorbeeld het administrator gedeelte te regelen.
Versiebeheer

Je kan versies van je project bijhouden middels beschrijvende commits. Je kan door middel van een online repository samenwerken aan een project, waarbij iedere programmeur zijn eigen inbreng heeft.

 

Voor het bijhouden van versies van een project gebruik ik Github. Dit is een perfect open source platform om je versies bij te houden van Github. Tijdens CLE projecten heb ik dit voor mijzelf gebruik maar ook in team verband. Om zo makkelijk samen als team aan een project te kunnen werken.

Bij Github heb je verschillende functie die je kan toepassen bij het gebruik van Github. Deze heb ik even op een rijtje gezet.

  • Push – met de push functie stuur je alle aanpassingen die je gedaan hebt naar de repository.
  • Fetch – met de Fetch functie haal je alle aanpassingen op van anderen binnen.
  • Pull request – met de pull request doe je een aanvraag om veranderingen toe te voegen aan de repository, deze moeten dan vervolgens goed gekeurd worden.
  • Merge – de merge functie gebruik je wanneer je een branch wilt samen voegen met de master branch.
  • Sync – met de Sync functie update je zowel je locale bestanden als de bestanden op de repository.

Ik heb op mijn eigen Github een paar projecten staan:

https://github.com/koenwestra

Daarnaast heb ik samen met mijn team een project met commits en branches:

https://github.com/berkbalik/CLE4GAME (is private, kan ik laten zien tijdens het assessment)

Overdracht

Je hebt user stories omgezet naar een lijst meetbare specificaties. Je bent in staat om een klantgerichte gebruikershandleiding op te leveren.

Voor CLE 2 heb ik een boekingssysteem gemaakt met de volgende user stories daarnaast heb ik ook de meetbare specificaties opgesteld:

User stories:

Meetbare specificaties:

Voor CLE 3 heb ik een boat race gemaakt met de volgende user stories daarnaast heb ik ook de meetbare specificaties opgesteld:

User stories:

Meetbare specificaties:

Voor de Frisian Yacht Club heb ik een gebruikershandleiding gemaakt: