Code conventies¶

Bij het programmeren van software moet worden gelet op de leesbaarheid en onderhoudbaarheid van de code. Hiertoe is het noodzakelijk om je aan een aantal principes te houden. Je moet letten op:

Een aantal code conventies zijn taalspecifiek:

Checklist

Gebruik deze checklist om bestaande code te beoordelen op het volgen van de code conventies.

Naamgeving¶

variabelenaam specificeert inhoud
variabelenaam in het Engels
namen met meerdere worden volgen standaard van de taal
functienamen bevatten werkwoord indien mogelijk

Commentaar¶

doel van het programma bovenin
parameters en return variabelen van functies
commentaar bij lastige code
geen onnodig commentaar

Code layout¶

indentatie
geen overbodige spaties
geen overbodige lege regels

Magische getallen¶

geen magische getallen
gebruik van constanten
constanten in ALL_CAPS