Gebruik van comments in mijn code
In mijn code maak ik gebruik van comments. Dit maakt mijn code makkelijker leesbaar, omdat elke functie in 'mensentaal' omschreven wordt. 
Het schrijven van een README.md
Om mijn code uit te leggen aan mijn groepsgenoten heb ik een README.md geschreven, waarin ik uitleg wat de benodigdheden zijn om mijn code werkend te krijgen en hoe je dit doet. Ook heb ik een stukje uitleg over de instellingen van de library.

Ik heb gebruik gemaakt van een populaire repo op GitHub, met uitleg over het schrijven van een goede readme. Hier heb ik ook voorbeelden uitgehaald over de Markdown language.

Mijn library met daarin mijn README.md kan hier worden gedownload.
Reflectie
Het leren van de Markdown language vond ik niet moeilijk, dat was vrij snel geleerd. Alleen met het schrijven van goede documentatie is het moeilijkste gebleken. Ik heb geprobeerd de template uit de repo te volgen, en heb van Mijke feedback gehad dat het duidelijk was. 
Qua zelfreflectie vind ik mijn readme aan de lange kant, voor een volgend project wil ik focussen op minder tekst een meer codevoorbeelden. Dit is naar eigen ervaring het prettigst.
Back to Top