Teknisk dokumentation og code review

Kommunikation og IT A · HTX · A-niveau · Systemudvikling

💻 Dokumentation og code review

Teknisk dokumentation sikrer at kode kan forstås og vedligeholdes:

Inline kommentarer: forklar HVORFOR, ikke hvad.

```python

Beregn daglig rente i stedet for månedlig — API returnerer månedlig

rente = månedlig_rente / 30

```

Docstrings (Python):

```python

def beregn_bmi(vægt_kg: float, højde_m: float) -> float:

"""Beregn Body Mass Index.

Args:

vægt_kg: Vægt i kilogram

højde_m: Højde i meter

Returns:

BMI som float

"""

return vægt_kg / (højde_m ** 2)

```

README.md: projektbeskrivelse, installation, kørsel, eksempler.

Code review — hvad man kigger efter:

1. Korrekthed: virker koden som forventet?

2. Læsbarhed: er variabelnavne forklarende?

3. Sikkerhed: er der OWASP-risici?

4. Performance: er der åbenlyse flaskehalse?

5. Tests: dækkes edge cases?

Pull Request-beskeder: forklar HVAD og HVORFOR, ikke trin for trin.

Læringsmål

• Skrive meningsfulde docstrings og inline kommentarer
• Oprette en god README.md til et projekt
• Gennemføre konstruktive code reviews med specifikke feedback
• Anvende type hints i Python for bedre dokumentation

Sådan kan du arbejde med emnet

• Skriv en kort teknisk dokumentation for en funktion, inkl. parametre og returværdi
• List tre ting man bør kigge efter i et code review
• Diskutér hvordan god dokumentation kan spare tid for et udviklingsteam

Træningsforslag

• Tilføj docstrings til alle funktioner i et eksisterende projekt
• Lav code review på en klassekammerats kode og giv konstruktiv feedback
• Brug Sphinx til automatisk dokumentationsgenerering fra docstrings