Code documentation¶

Om jouw code beter te kunnen begrijpen en overdagen is het noodzakelijk om jouw code te documenteren.

Wat is documentatie¶

Documentatie is een manier om d.m.v. tekst aan te duiden wat er in jouw code gebeurt. Het doel hiervan is, dat als jij later weer terug kom bij functies of klassen die je een tijd geleden hebt geschreven dat je niet alle code door hoef te lezen om te begrijp wat deze doen.

Manieren van documentatie¶

Apparte documenten¶

Klassendiagram¶

Een klassendiagram is een bestand waarin weergegeven wordt welke properties en functies deel uit maken van een klas. Ook wordt in een klassendiagram weergegeven hoe klassen relaties met elkaar hebben.

In code¶

Comments¶

Om extra duidlijkheid te geven aan je code kan je comments toevoegen. Als jij een variabele heb genaamd ‘inhoud’ zou je daar achter kunnen zetten met een comment dat het om liter gaat.

JSDoc¶

Je kan ook gebuik maken van JSDoc om je code te documenteren. JSDoc is een standaard voor hoe je jouw code documenteer in JavaScript. Op de knowledgebase staat ook een uitleg over JSDoc.