Skip to content

Code documenteren

Inleiding

In het eerste project heb je geleerd hoe je commentaar kan toevoegen aan je code om het te verduidelijken. Veel programmeertalen hebben een standaard voor het documenteren van code. Deze standaarden hebben als voordeel dat documentatie kan worden gegenereerd uit het commentaar. Voorbeelden van dergelijke standaarden zijn TSDoc voor TypeScript, JSDoc voor JavaScript en Docstrings voor Python.

Hoe kan ik dit leren?

Gebruik de HBO-ICT Knowledgebase om de volgende vragen te beantwoorden:

  • Hoe schrijf ik commentaar voor een class in mijn code?
  • Hoe schrijf ik commentaar voor een function of method in mijn code?

Hoe toon ik dit aan?

  • Al de door mij geschreven code is gedocumenteerd volgens de geldende standaard.