2.8 KiB
Geef commentaar op je code
Instructies
Schone, goed gedocumenteerde code is essentieel voor het onderhouden en delen van je projecten. In deze opdracht oefen je een van de belangrijkste gewoontes van professionele ontwikkelaars: het schrijven van duidelijke, nuttige opmerkingen die de bedoeling en functionaliteit van je code uitleggen.
Bekijk je huidige app.js bestand in je game-map en zoek manieren om het te voorzien van commentaar en op te schonen. Code kan heel snel onoverzichtelijk worden, en dit is een goed moment om opmerkingen toe te voegen zodat je later begrijpelijke code hebt die je kunt gebruiken.
Je taak omvat:
- Voeg opmerkingen toe die uitleggen wat elk belangrijk deel van de code doet
- Documenteer functies met duidelijke beschrijvingen van hun doel en parameters
- Organiseer de code in logische blokken met sectiekoppen
- Verwijder ongebruikte of overbodige code
- Gebruik consistente naamgevingsconventies voor variabelen en functies
Beoordelingscriteria
| Criteria | Uitmuntend | Voldoende | Verbetering nodig |
|---|---|---|---|
| Code Documentatie | app.js code is volledig voorzien van duidelijke, nuttige uitleg voor alle belangrijke secties en functies |
app.js code is voldoende voorzien van basisuitleg voor de meeste secties |
app.js code heeft minimale opmerkingen en mist duidelijke uitleg |
| Code Organisatie | Code is georganiseerd in logische blokken met duidelijke sectiekoppen en consistente structuur | Code heeft enige organisatie met basisgroepering van gerelateerde functionaliteit | Code is enigszins ongeorganiseerd en moeilijk te volgen |
| Code Kwaliteit | Alle variabelen en functies hebben beschrijvende namen, geen ongebruikte code, volgt consistente conventies | De meeste code volgt goede naamgevingspraktijken met minimale ongebruikte code | Variabelennamen zijn onduidelijk, bevat ongebruikte code, inconsistente stijl |
Disclaimer:
Dit document is vertaald met behulp van de AI-vertalingsservice Co-op Translator. Hoewel we streven naar nauwkeurigheid, dient u zich ervan bewust te zijn dat geautomatiseerde vertalingen fouten of onnauwkeurigheden kunnen bevatten. Het originele document in de oorspronkelijke taal moet worden beschouwd als de gezaghebbende bron. Voor kritieke informatie wordt professionele menselijke vertaling aanbevolen. Wij zijn niet aansprakelijk voor eventuele misverstanden of verkeerde interpretaties die voortvloeien uit het gebruik van deze vertaling.