Stijl

Een goed programma wordt (onder andere) gekenmerkt door nette code. Niet alleen maak je je source daarmee leesbaar voor anderen, je maakt het ook voor jezelf makkelijker om de code te onderhouden. Hieronder vind je een lijstje met wat naar mijn mening de minimale eisen zijn die je aan goede code kunt stellen. Dit zijn geen keiharde eisen aan wat jullie schrijven, zie het meer als een richtlijn. Als het goed is kun je zelf met je gezonde verstand ook wel bepalen wanneer je code leesbaar is of niet.

• Een consistende lay-out: erg belangrijk. Dit betekent niet alleen overal netjes inspringen, maar ook een consistent gebruik van spaties, comma's, e.d. Zorg dat de lay-out van je programma samenhangt met de betekenis ervan.
• Commentaar: code zonder commentaar is m.i. onacceptabel. Zorg ervoor dat je commentaar levert bij alles wat je programma doet wat niet volledig triviaal en voor de hand liggend is. Lever in ieder geval commentaar bij de werking van iedere functie/procedure die je schrijft.
• Naamgeving: Zorg ervoor dat de namen van je variabelen en functies 'self-explanatory' (zelfverklarend?) zijn. Kies als namen dus niet s1, s2 en s3, maar successorState1, successorState2 en goalState. Het kost misschien wat meer typewerk, maar het scheelt je zeker een hoop denkwerk als je een week niet naar je programma gekeken hebt...